polleverywhere 0.0.2 → 0.0.4

data/.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 *.gem
 .bundle
+.sass-cache
 Gemfile.lock
 pkg/*

data/Gemfile

@@ -11,4 +11,9 @@ group :development, :test do
   gem 'haml'
   gem 'rake'
   gem 'ruby-debug19'
+end
+
+group :api_docs do
+  gem 'middleman'
+  gem 'sourcify'
 end

data/README.md

@@ -1,4 +1,4 @@
-# Poll Everywhere API Gem
+# The Official Poll Everywhere API Gem
 
 The Poll Everywhere gem is the best way to integrate Poll Everywhere with your applications.
 
@@ -22,19 +22,20 @@ If you're using bundler, add the following line to your Gemfile:
       password  "my_password"
     end
     
-    # Now start playing!
-    polls = PollEverywhere::Poll.all
-    poll = poll.first
-    poll.close
-    poll.title = "Hey there, I like changing titles around"
-    poll.options = %w[uno dos tres]
+    # Create a multiple choice poll
+    poll = PollEverywhere::MultipleChoicePoll.new
+    poll.title = 'Do you love numbers?'
+    poll.options = %w[1 2 3]
+    poll.save
+    # Create a free text poll    
+    poll = PollEverywhere::FreeTextPoll.new
+    poll.title = 'What is your favorite thing about vacation?'
     poll.save
-    poll.open
+    # Now start playing! Get a list of your polls
+    polls = PollEverywhere::Poll.all
 
 You can do all sorts of fun stuff with polls!
 
-# TODO
-
 A roadmap for our API:
 
 * API models and documentation for more pieces of our application

data/Rakefile

@@ -1,14 +1,15 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
-require 'haml'
 require 'polleverywhere'
 
 namespace :doc do
   desc "Generate API documentation"
   task :api do
     PollEverywhere.config do
-      username "test"
-      password "test"
+      username      "test"
+      password      "test"
+      url           "http://api.polleverywhere.com"
+      http_adapter  :doc
     end
 
     puts PollEverywhere::API::Documentation.generate

data/api/config.rb

@@ -0,0 +1,64 @@
+# CodeRay syntax highlighting in Haml
+# activate :code_ray
+
+# Automatic sitemaps (gem install middleman-slickmap)
+# require "middleman-slickmap"
+# activate :slickmap
+
+# Automatic image dimension calculations
+# activate :automatic_image_sizes
+
+# Per-page layout changes
+# With no layout
+# page "/path/to/file.html", :layout => false
+# With alternative layout
+# page "/path/to/file.html", :layout => :otherlayout
+
+# Helpers
+helpers do
+  def examples(model)
+    model.http.adapter.request.to_curl
+  end
+
+  def example(&block)
+    formats = {}
+    block.call
+    # formats[:ruby] = block.to_source(:strip_enclosure => true)
+    formats[:curl] = PollEverywhere.config.http_adapter.last_requests.map(&:to_curl).join("\n\n")
+    puts formats.map{ |format, example| %(<pre class="#{format}">#{example}</pre>) }.join
+  end
+end
+
+# Change the CSS directory
+# set :css_dir, "alternative_css_directory"
+
+# Change the JS directory
+# set :js_dir, "alternative_js_directory"
+
+# Change the images directory
+# set :images_dir, "alternative_image_directory"
+
+# Build-specific configuration
+configure :build do
+  # For example, change the Compass output style for deployment
+  # activate :minify_css
+  
+  # Minify Javascript on build
+  # activate :minify_javascript
+  
+  # Enable cache buster
+  # activate :cache_buster
+  
+  # Use relative URLs
+  # activate :relative_assets
+  
+  # Compress PNGs after build (gem install middleman-smusher)
+  # require "middleman-smusher"
+  # activate :smusher
+
+  # Generate ugly/obfuscated HTML from Haml
+  # activate :ugly_haml
+  
+  # Or use a different image path
+  # set :http_path, "/Content/images/"
+end

data/api/config.ru

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'middleman'
+require 'polleverywhere'
+require 'sourcify'
+
+PollEverywhere.config do
+  username      "test"
+  password      "test"
+  url           "http://localhost:3000"
+  http_adapter  :doc
+end
+
+run Middleman::Server

data/api/views/index.html.haml

@@ -0,0 +1,112 @@
+!!! html
+%html
+  %head
+    %title Poll Everywhere API
+  %body
+    %header
+      %h1 Poll Everywhere API Documentation
+
+    %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 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'.
+
+      %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 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 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 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 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

data/api/views/layout.haml

@@ -0,0 +1,21 @@
+!!! 5
+%html{ :lang => "en" }
+  %head
+    %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"
+
+    :javascript
+      // Comment in javascript
+
+    = yield_content :head
+    
+  %body{ :class => page_classes }
+
+    #main{ :role => "main" }
+      = yield

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

@@ -0,0 +1,42 @@
+@import "compass"
+
+$base-font-size: 16px
+$code-font-size: 13px
+
+body
+  font:
+    family: Georgia, Palatino, "Palatino Linotype", Times, "Times New Roman", serif
+    size: $base-font-size
+  width: 40em
+  margin: auto auto
+
+code
+  font-family: monaco, courier
+  font-size: $code-font-size
+  line-height: $base-font-size
+  padding: $base-font-size
+  display: block
+  padding: 1em
+  background: #eee
+  margin: 1em 0
+
+h1,h2,h3,h4,h5,h6
+  font-weight: normal
+
+h1
+  font-size: 30px
+h2
+  font-size: 24px
+h3,h4,h5.h6
+  font-size: 20px
+
+dl.attributes
+  dt
+    margin-top: 1em
+    font-family: courier
+    font-size: $code-font-size
+    line-height: $base-font-size
+  dl, dd
+    margin-left: 0
+  dd > dl
+    margin-left: 1em

data/docs/api.haml

@@ -5,21 +5,22 @@
   %body
     %header
       %h1 Poll Everywhere API Documentation
-      %em Disclaimer: this documentation is only intended for an internal preview. Hold off on using this stuff until we announce it on our blog.
 
     %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.  
+      %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 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'.
-      
+
       %h1 Polls
       %h2 Multiple choice polls
-      %h3 JSON Attributes
-      %dl
+      %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 Attributes
+      %dl.attributes
         %dt=PollEverywhere::MultipleChoicePoll.root_key
         %dd Root key for multiple choice poll data.
         %dd
@@ -33,33 +34,43 @@
                     -PollEverywhere::MultipleChoicePoll::Option.props.each do |_, prop|
                       %dt=prop.name
                       %dd=prop.description
-
       %h3 Creating a multiple choice poll
-      -@mcp = PollEverywhere::MultipleChoicePoll.from_hash(:title => 'Hey dude!', :options => %w[red blue green]).save
-      %code=examples @mcp  
-
-      %h3 Changing the title of the multiple choice poll
-      -@mcp.title = "I like different titles"
-      -@mcp.save
-      %code=examples @mcp  
+      :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 Closing and opening multiple choice polls
       %p To close a poll, change the state to "closed"
-      -@mcp.stop
-      %code=examples @mcp
+      :ruby
+        example do
+          @mcp.stop
+        end
       
       %p To open it back up (and allow responses to come on through) change the state to "opened"
-      -@mcp.start
-      %code=examples @mcp
+      :ruby
+        example do
+          @mcp.start
+        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
-      -@mcp.destroy
-      %code=examples @mcp  
-
+      :ruby
+        example do
+          @mcp.destroy
+        end
+      
       %h2 Free text polls
-      %h3 JSON Attributes
-      %dl
+      %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
@@ -70,18 +81,25 @@
 
       %h3 Create free text polls
       %p Creating a free text poll is similar to building a multiple choice poll, just without the options attribute.
-      -@ftp = PollEverywhere::FreeTextPoll.from_hash(:title => "What is the meaning of life?").save
-      %code=examples @ftp  
-      
+      :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
-      -@ftp.state = "opened"
-      -@ftp.save
-      %code=examples @ftp
-      
+      :ruby
+        example do
+          @ftp.state = "opened"
+          @ftp.save
+        end
+
       %h3 Delete a free text poll
-      -@ftp.destroy
-      %code=examples @ftp
+      :ruby
+        example do
+          @ftp.destroy
+        end
+
     %footer
       %p
         This documentation was automatically generated by the Poll Everywhere rubygem at

data/lib/polleverywhere/api.rb

@@ -1,3 +1,4 @@
+# require 'sourcify'
 require 'haml'
 
 module PollEverywhere
@@ -23,6 +24,14 @@ module PollEverywhere
       def examples(model)
         model.http.adapter.request.to_curl
       end
+
+      def example(&block)
+        formats = {}
+        block.call
+        # formats[:ruby] = block.to_source(:strip_enclosure => true)
+        formats[:curl] = PollEverywhere.config.http_adapter.last_requests.map(&:to_curl).join("\n\n")
+        puts formats.map{ |format, example| %(<pre class="#{format}">#{example}</pre>) }.join
+      end
     end
   end
 end

data/lib/polleverywhere/configuration.rb

@@ -27,7 +27,7 @@ module PollEverywhere
     # this form of authorization will be replaced with a token authorization 
     # so that a password is not required.
     def http_basic_credentials
-      "Basic #{Base64.encode64("#{username}:#{password}")}"
+      "Basic #{Base64.encode64("#{username}:#{password}")}".chomp
     end
   end
 end

data/lib/polleverywhere/http/adapter.rb

@@ -33,7 +33,7 @@ module PollEverywhere
           requests << request
           super request, &block
         end
-
+        
         def requests
           @requests ||= []
         end

data/lib/polleverywhere/http.rb

@@ -11,7 +11,7 @@ module PollEverywhere
     # Simple HTTP request/response objects for our adapter and DSL
     class Request < Struct.new(:method, :url, :headers, :body)
       def to_curl
-        %(curl -X #{method.to_s.upcase} #{headers.map{|h,v| %(-H "#{h}: #{v}")}.join(" ")} -d "#{body.gsub(/[!"`']/){|m| "\\#{m}" }}" "#{url}")
+        %(curl -X #{method.to_s.upcase} #{headers.map{|h,v| %(-H "#{h}: #{v}")}.join(" ")} -d "#{body.gsub(/[!"`'\n]/){|m| "\\#{m}" }}" "#{url}")
       end
     end
 

data/lib/polleverywhere/models.rb

@@ -1,10 +1,9 @@
 module PollEverywhere # :nodoc
   module Models # :nodoc
-
-    # Poll is an abstract base classe for multiple choice and free text polls
+    # Poll is an abstract base class for multiple choice and free text polls
     class Poll
       include Serializable
-
+      
       prop :id
       
       prop :updated_at do
@@ -19,10 +18,6 @@ module PollEverywhere # :nodoc
         description %{Data and time that the poll was started.}
       end
 
-      prop :options do
-        description %{The possible choices that people choose for a poll.}
-      end
-
       prop :permalink do
         description %{An obscufated ID that's used as a private link for sharing the poll}
       end
@@ -39,13 +34,13 @@ module PollEverywhere # :nodoc
 
       # Start the poll so that it may receive audience responses
       def start
-        state = "opened"
+        self.state = "opened"
         save
       end
 
       # Stop the poll so that it stops receieving responses
       def stop
-        state = "closed"
+        self.state = "closed"
         save
       end
 
@@ -109,10 +104,16 @@ module PollEverywhere # :nodoc
 
       root_key :multiple_choice_poll
 
+      prop :options do
+        description %{The possible choices that people choose for a poll.}
+      end
+
       class Option
         include Serializable
 
-        prop :id
+        prop :id do
+          description "Unique identifier for the option. This is primarily used to keep track of what option attributes are changed."
+        end
 
         prop :value do
           description "Text that is displayed in the chart that represents what a participant chooses when they response to a poll."

data/lib/polleverywhere/version.rb

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

data/polleverywhere.gemspec

@@ -7,14 +7,15 @@ Gem::Specification.new do |s|
   s.version     = Polleverywhere::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Brad Gessler, Steel Fu"]
-  s.email       = ["geeks@polleverywhere.com"]
-  s.homepage    = "http://www.polleverywhere.com/"
-  s.summary     = %q{Integration Poll Everywhere into your Ruby applications}
+  s.email       = ["opensource@polleverywhere.com"]
+  s.homepage    = "http://www.github.com/polleverywhere/polleverywhere"
+  s.summary     = %q{Integrate Poll Everywhere into your Ruby applications}
   s.description = %q{An easy way to integrate Poll Everywhere into your Ruby applications.}
-
+  
   s.rubyforge_project = "polleverywhere"
   s.add_dependency "json"
-  s.add_development_dependency "rest-client", "~> 1.6.3"
+  # TODO get rid of this dependency by using Ruby Net::HTTP
+  s.add_dependency "rest-client", "~> 1.6.3"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/integration/api_spec.rb

@@ -60,6 +60,16 @@ describe "API" do
         it "should update title" do
           @mcp.title.should eql("My pita bread is moldy")
         end
+
+        it "should start" do
+          @mcp.start
+          @mcp.state.should eql("opened")
+        end
+
+        it "should stop" do
+          @mcp.stop
+          @mcp.state.should eql("closed")
+        end
       end
 
       it "should destroy" do

metadata

@@ -2,7 +2,7 @@
 name: polleverywhere
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors: 
 - Brad Gessler, Steel Fu
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-24 00:00:00 -07:00
+date: 2011-06-27 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,11 +33,11 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.6.3
-  type: :development
+  type: :runtime
   version_requirements: *id002
 description: An easy way to integrate Poll Everywhere into your Ruby applications.
 email: 
-- geeks@polleverywhere.com
+- opensource@polleverywhere.com
 executables: []
 
 extensions: []
@@ -51,6 +51,12 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- api/build/index.html
+- api/config.rb
+- api/config.ru
+- api/views/index.html.haml
+- api/views/layout.haml
+- api/views/stylesheets/site.css.sass
 - docs/api.haml
 - lib/polleverywhere.rb
 - lib/polleverywhere/api.rb
@@ -68,7 +74,7 @@ files:
 - spec/lib/polleverywhere_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://www.polleverywhere.com/
+homepage: http://www.github.com/polleverywhere/polleverywhere
 licenses: []
 
 post_install_message: 
@@ -94,7 +100,7 @@ rubyforge_project: polleverywhere
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Integration Poll Everywhere into your Ruby applications
+summary: Integrate Poll Everywhere into your Ruby applications
 test_files: 
 - spec/integration/api_spec.rb
 - spec/lib/polleverywhere_spec.rb