polleverywhere 0.0.4 → 0.0.5

metadata

@@ -1,68 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: polleverywhere
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Brad Gessler, Steel Fu
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-27 00:00:00 -06:00
+date: 2011-07-03 00:00:00.000000000 -06:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2156899600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2156899600
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2156899080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.6.3
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2156899080
 description: An easy way to integrate Poll Everywhere into your Ruby applications.
-email: 
+email:
 - opensource@polleverywhere.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - Gemfile
 - Guardfile
 - README.md
 - Rakefile
-- api/build/index.html
 - api/config.rb
 - api/config.ru
+- api/public/favicon.ico
+- api/public/javascripts/jquery-1.6.2.min.js
+- api/public/javascripts/jquery.tableofcontents.js
 - 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
 - lib/polleverywhere/configurable.rb
 - lib/polleverywhere/configuration.rb
 - lib/polleverywhere/core_ext.rb
+- lib/polleverywhere/haml.rb
 - lib/polleverywhere/http.rb
 - lib/polleverywhere/http/adapter.rb
 - lib/polleverywhere/http/request_builder.rb
@@ -76,32 +73,29 @@ files:
 has_rdoc: true
 homepage: http://www.github.com/polleverywhere/polleverywhere
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: polleverywhere
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Integrate Poll Everywhere into your Ruby applications
-test_files: 
+test_files:
 - spec/integration/api_spec.rb
 - spec/lib/polleverywhere_spec.rb
 - spec/spec_helper.rb

data/docs/api.haml

@@ -1,112 +0,0 @@
-!!! 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/lib/polleverywhere/api.rb

@@ -1,37 +0,0 @@
-# require 'sourcify'
-require 'haml'
-
-module PollEverywhere
-  module API
-    # Generates API integration documentation from HAML
-    class Documentation
-      attr_reader :template
-
-      def initialize(template)
-        @template = template
-      end
-
-      # Generates API documentation
-      def generate
-        Haml::Engine.new(template, :format => :html5).render(self)
-      end
-
-      # Generate the HAML documentation from the default docs path
-      def self.generate(path=File.expand_path('../../../docs/api.haml', __FILE__))
-        new(File.read(path)).generate
-      end
-
-      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