polleverywhere 0.0.7 → 0.0.8

data/.rvmrc

@@ -1 +1,36 @@
-rvm 1.9.2@polleverywhere_gem
+#!/usr/bin/env bash
+
+# Bare minimum Gems that are needed to keep a Ruby development environment in sync. This assumes
+# that you use bundler in your workflow to control the installation of all other gems. If you need
+# to bump the bundler or rubygem version across your team, change that here, then run bundler and
+# and keep going.
+
+RVMRC=1.9.2@polleverywhere_gem
+RUBYGEM_VERSION="1.6.2"
+BUNDLER_VERSION="1.0.15"
+
+# Make this work with OS X Lion... for now...
+if [[ `uname -v` =~ "Darwin Kernel Version 11" ]] ; then
+  export CC=/usr/bin/gcc-4.2
+fi
+
+# # Make sure we're using the right version for ruby
+rvm use --create --install $RVMRC
+
+# Enforce a version of Rubygems
+if [[ `gem --version` != $RUBYGEM_VERSION ]] ; then
+  echo "Updating to RubyGems $RUBYGEM_VERSION..."
+  rvm rubygems $RUBYGEM_VERSION
+fi
+
+# Check if bundler is installed
+if [[ "command -v bundle" ]] ; then
+  # Check if we have the right version
+  if [[ ! (`bundle --version` =~ $BUNDLER_VERSION) ]] ; then
+    echo "Updating to Bundler $BUNDLER_VERSION..."
+    gem install bundler -v$BUNDLER_VERSION
+  fi
+else
+  echo "Installing Bundler $BUNDLER_VERSION..."
+  gem install bundler -v$BUNDLER_VERSION
+fi

data/api/views/index.html.haml

@@ -1,7 +1,11 @@
 %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
+  %h1 Getting started
+  %p We're really stoked that you want to integrate Poll Everywhere into your application. We built this API with goal of providing developers with a simple, reliable, and enjoyable way to integrate Poll Everywhere into applications.
+
+  %h2 We ♥ 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'.
+
+  %h2 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>).
@@ -12,9 +16,11 @@
         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'.
+
+  %h2 Support
+  %p We regularly run a <a href="https://github.com/polleverywhere/polleverywhere/tree/master/spec/integration">suite of integration tests</a> against our API to make sure that our API is running smoothly.
+
+  %p Now lets roll up our sleeves and get our hands dirty!
 
   %h1 Polls
   %h2 Multiple choice polls
@@ -22,18 +28,21 @@
 
   %h3 Attributes
   %dl.attributes
-    %dt=PollEverywhere::MultipleChoicePoll.root_key
+    %dt
+      %code=PollEverywhere::MultipleChoicePoll.root_key
     %dd Root key for multiple choice poll data.
     %dd
       %dl
         -PollEverywhere::MultipleChoicePoll.prop_set.each do |_, prop|
-          %dt=prop.name
+          %dt
+            %code=prop.name
           %dd=prop.description
           -if prop.name == :options
             %dd
               %dl
                 -PollEverywhere::MultipleChoicePoll::Option.prop_set.each do |_, prop|
-                  %dt=prop.name
+                  %dt
+                    %code=prop.name
                   %dd=prop.description
   
   %h3 Creating a multiple choice poll
@@ -55,6 +64,11 @@
   :example
     @mcp.start
 
+  %h3 Clear the poll results
+  %p To clear out any current results on a poll, you call the clear method
+  :example
+    @mcp.clear
+
   %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
@@ -64,12 +78,14 @@
   %p These polls are used to collect short answers or unstructured responses from participants.
   %h3 Attributes
   %dl.attributes
-    %dt=PollEverywhere::FTP.root_key
+    %dt
+      %code=PollEverywhere::FTP.root_key
     %dd Root key for free text poll data.
     %dd
       %dl
         -PollEverywhere::FTP.prop_set.each do |_, prop|
-          %dt=prop.name
+          %dt
+            %code=prop.name
           %dd=prop.description
 
   %h3 Create free text polls
@@ -83,6 +99,11 @@
     @ftp.title = "No really, what is the meaning of life?"
     @ftp.save
 
+  %h3 Clear the poll results
+  %p To clear out any current results on a poll, you call the clear method
+  :example
+    @ftp.clear
+
   %h3 Delete a free text poll
   :example
     @ftp.destroy
@@ -92,12 +113,14 @@
 
   %h2 Attributes
   %dl.attributes
-    %dt=PollEverywhere::Participant.root_key
+    %dt
+      %code=PollEverywhere::Participant.root_key
     %dd Root key for participant data.
     %dd
       %dl
         -PollEverywhere::Participant.prop_set.each do |_, prop|
-          %dt=prop.name
+          %dt
+            %code=prop.name
           %dd=prop.description
   
   %h2 Creating a new Participant

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

@@ -24,11 +24,12 @@ pre
     overflow: visible
 
 code
-  font-family: monaco, courier
-  font-size: $code-font-size
+  font:
+    family: monaco, courier
+    size: $code-font-size
   background: #eee
   line-height: $base-font-size
-  padding: 1px
+  padding: 2px
 
 h1,h2,h3,h4,h5,h6
   font-weight: normal
@@ -41,10 +42,7 @@ h3,h4,h5.h6
 
 dl.attributes
   dt
-    margin-top: 1em
-    font-family: courier
-    font-size: $code-font-size
-    line-height: $base-font-size
+    margin: 1em auto 0.25em
   dl, dd
     margin-left: 0
   dd > dl

data/lib/polleverywhere/models.rb

@@ -77,7 +77,7 @@ module PollEverywhere # :nodoc
       end
 
       prop :opened_at do
-        description %{Data and time that the poll was started.}
+        description %{Date and time that the poll was started.}
       end
 
       prop :permalink do
@@ -88,6 +88,22 @@ module PollEverywhere # :nodoc
         description %{Determines whether or not a poll can recieve responses. If the state is 'closed', the poll won't receive responses from the audience. If the poll is 'opened', the poll can receive responses from the audience. If the state is 'maxed_out', the poll won't receive responses until the account is upgraded to support more poll responses.}
       end
 
+      prop :sms_enabled do
+        description %{Allow participants to respond to the poll using SMS text messages.}
+      end
+
+      prop :twitter_enabled do
+        description %{Allow participants to respond to the poll with Twitter.}
+      end
+
+      prop :web_enabled do
+        description %{Allow participants to respond to the poll with their web browsers through the poll owners PollEv.com page.}
+      end
+
+      prop :sharing_enabled do
+        description %{Allow participants to respond to the poll through the obscufated permalink.}
+      end
+
       attr_accessor :http
 
       def initialize(http=PollEverywhere.http)
@@ -139,6 +155,18 @@ module PollEverywhere # :nodoc
         end
       end
 
+      def clear
+        if persisted?
+          http.delete(path + "/clear").response do |response|
+            return true
+          end
+
+          return false
+        else
+          false
+        end
+      end
+
       def destroy
         http.delete(path).response do |response|
           self.id = self.permalink = nil

data/lib/polleverywhere/version.rb

@@ -1,3 +1,3 @@
 module PollEverywhere
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/integration/api_spec.rb

@@ -72,6 +72,11 @@ describe "API" do
         end
       end
 
+      it "should clear results" do
+        @mcp.save
+        @mcp.clear.should be_true
+      end
+
       it "should destroy" do
         @mcp.destroy
         @mcp.id.should be_nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polleverywhere
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-15 00:00:00.000000000 -07:00
-default_executable: 
+date: 2011-09-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156434260 !ruby/object:Gem::Requirement
+  requirement: &70254757011980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156434260
+  version_requirements: *70254757011980
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2156433200 !ruby/object:Gem::Requirement
+  requirement: &70254757011480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +32,7 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *2156433200
+  version_requirements: *70254757011480
 description: An easy way to integrate Poll Everywhere into your Ruby applications.
 email:
 - opensource@polleverywhere.com
@@ -72,7 +71,6 @@ files:
 - spec/lib/polleverywhere_spec.rb
 - spec/lib/serializable_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://www.github.com/polleverywhere/polleverywhere
 licenses: []
 post_install_message: 
@@ -93,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: polleverywhere
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Integrate Poll Everywhere into your Ruby applications