polleverywhere 0.0.5 → 0.0.6

data/Gemfile

@@ -9,6 +9,7 @@ group :development, :test do
   gem 'growl'
   gem 'rspec'
   gem 'ruby-debug19'
+  gem 'rake'
 end
 
 group :api_docs do

data/api/views/index.html.haml

@@ -85,4 +85,31 @@
 
   %h3 Delete a free text poll
   :example
-    @ftp.destroy
+    @ftp.destroy
+  
+  %h1 Participants
+  %p Participants are used to identify who is responding to your polls.    
+
+  %h2 Attributes
+  %dl.attributes
+    %dt=PollEverywhere::Participant.root_key
+    %dd Root key for participant data.
+    %dd
+      %dl
+        -PollEverywhere::Participant.props.each do |_, prop|
+          %dt=prop.name
+          %dd=prop.description
+  
+  %h2 Creating a new Participant
+  %p Specify the details of a new participant
+  :example
+    @participant = PollEverywhere::Participant.from_hash(:email => 'b.obama@whitehouse.gov', :first_name => 'Barack', :last_name => 'Obama', :password => 'mickeymouse', :responding_as => 'Barack').save
+  
+  %h2 Updating participant details
+  :example
+    @participant.first_name = "President"
+    @participant.save
+
+  %h2 Delete a Participant
+  :example
+    @participant.destroy

data/lib/polleverywhere/models.rb

@@ -1,5 +1,58 @@
 module PollEverywhere # :nodoc
   module Models # :nodoc
+    class Participant
+      include Serializable
+
+      root_key :user
+
+      prop :first_name
+
+      prop :last_name
+
+      prop :email
+
+      prop :phone_number do
+        description %{Phone number associated with the participant.}
+      end
+
+      prop :responding_as do
+        description %{This is used to identify the participant in reports.}
+      end
+
+      prop :password
+
+      attr_accessor :http
+
+      def initialize(http=PollEverywhere.http)
+        self.http = http
+      end
+
+      def save
+        http.put(to_json).as(:json).to(path).response do |response|
+          from_json response.body
+        end
+      end
+
+      def self.get(email)
+        from_hash(:email => email).fetch
+      end
+
+      def destroy
+        http.delete(path).response do |response|
+        end
+      end
+
+      def path
+        "/participants/#{email}"
+      end
+
+      def fetch
+        http.get.from(path).as(:json).response do |response|
+          from_json response.body
+        end
+      end
+    end
+
     # Poll is an abstract base class for multiple choice and free text polls
     class Poll
       include Serializable

data/lib/polleverywhere/version.rb

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

data/lib/polleverywhere.rb

@@ -8,8 +8,10 @@ module PollEverywhere
 
   # Lets make life easier for developers and provide shortcuts to module and class names. 
   # PollEverywhere::Model::MultipleChoicePoll now becomes PollEverywhere::MCP. Cool eh? Thank me later.
+  Participant = Models::Participant
   MCP = MultipleChoicePoll = Models::MultipleChoicePoll
   FTP = FreeTextPoll = Models::FreeTextPoll
+  
 
   def self.config(&block)
     @config ||= Configuration.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polleverywhere
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-03 00:00:00.000000000 -06:00
+date: 2011-07-12 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156899600 !ruby/object:Gem::Requirement
+  requirement: &2156511940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156899600
+  version_requirements: *2156511940
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2156899080 !ruby/object:Gem::Requirement
+  requirement: &2156511340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *2156899080
+  version_requirements: *2156511340
 description: An easy way to integrate Poll Everywhere into your Ruby applications.
 email:
 - opensource@polleverywhere.com