polleverywhere 0.0.6 → 0.0.7

data/api/views/index.html.haml

@@ -26,13 +26,13 @@
     %dd Root key for multiple choice poll data.
     %dd
       %dl
-        -PollEverywhere::MultipleChoicePoll.props.each do |_, prop|
+        -PollEverywhere::MultipleChoicePoll.prop_set.each do |_, prop|
           %dt=prop.name
           %dd=prop.description
           -if prop.name == :options
             %dd
               %dl
-                -PollEverywhere::MultipleChoicePoll::Option.props.each do |_, prop|
+                -PollEverywhere::MultipleChoicePoll::Option.prop_set.each do |_, prop|
                   %dt=prop.name
                   %dd=prop.description
   
@@ -68,7 +68,7 @@
     %dd Root key for free text poll data.
     %dd
       %dl
-        -PollEverywhere::FTP.props.each do |_, prop|
+        -PollEverywhere::FTP.prop_set.each do |_, prop|
           %dt=prop.name
           %dd=prop.description
 
@@ -96,7 +96,7 @@
     %dd Root key for participant data.
     %dd
       %dl
-        -PollEverywhere::Participant.props.each do |_, prop|
+        -PollEverywhere::Participant.prop_set.each do |_, prop|
           %dt=prop.name
           %dd=prop.description
   
@@ -104,12 +104,18 @@
   %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.responding_as = "Mr. President"
     @participant.save
 
+  %h2 Changing an email address
+  %p.http Changing an email address is a slightly special case at an HTTP level because the new email address should be in the body of the participant data and should be <code>PUT</code> to the original email address.
+  :example
+    @participant.email = "mr.president@hotmail.com"
+    @participant.save
+  
   %h2 Delete a Participant
   :example
     @participant.destroy

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

@@ -23,6 +23,13 @@ pre
   &:hover
     overflow: visible
 
+code
+  font-family: monaco, courier
+  font-size: $code-font-size
+  background: #eee
+  line-height: $base-font-size
+  padding: 1px
+
 h1,h2,h3,h4,h5,h6
   font-weight: normal
 h1

data/lib/polleverywhere/http.rb

@@ -11,7 +11,14 @@ 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(/[!"`'\n]/){|m| "\\#{m}" }}" "#{url}")
+        case method.to_s
+        when /^put|post$/i
+          %(curl -X #{method.to_s.upcase} #{headers.map{|h,v| %(-H "#{h}: #{v}")}.join(" ")} -d "#{body.gsub(/[!"`'\n]/){|m| "\\#{m}" }}" "#{url}")
+        when /^get$/i
+          %(curl #{headers.map{|h,v| %(-H "#{h}: #{v}")}.join(" ")} "#{url}")
+        else
+          %(curl -X #{method.to_s.upcase} #{headers.map{|h,v| %(-H "#{h}: #{v}")}.join(" ")} "#{url}")
+        end
       end
     end
 

data/lib/polleverywhere/http/adapter.rb

@@ -20,7 +20,7 @@ module PollEverywhere
         end
         
         def execute(request, &block)
-          @request = request
+          @request, @response = request, nil
           # TODO get rid of the dependency for RestClient by sucking it up and using the Ruby HTTP client
           RestClient::Request.execute(:method => request.method, :url => request.url.to_s, :payload => request.body, :headers => request.headers) do |r,_,_,_|
             @response = block.call Response.new(r.code, r.headers, r.body)

data/lib/polleverywhere/models.rb

@@ -5,11 +5,17 @@ module PollEverywhere # :nodoc
 
       root_key :user
 
-      prop :first_name
+      prop :first_name do
+        description "First name of the participant"
+      end
 
-      prop :last_name
+      prop :last_name do
+        description "Last name of the participant"
+      end
 
-      prop :email
+      prop :email do
+        description "Email address of pariticpant"
+      end
 
       prop :phone_number do
         description %{Phone number associated with the participant.}
@@ -19,7 +25,9 @@ module PollEverywhere # :nodoc
         description %{This is used to identify the participant in reports.}
       end
 
-      prop :password
+      prop :password do
+        description %{Password that the participant may use to login to their account and view their response history.}
+      end
 
       attr_accessor :http
 
@@ -29,6 +37,7 @@ module PollEverywhere # :nodoc
 
       def save
         http.put(to_json).as(:json).to(path).response do |response|
+          value_set.commit
           from_json response.body
         end
       end
@@ -38,12 +47,12 @@ module PollEverywhere # :nodoc
       end
 
       def destroy
-        http.delete(path).response do |response|
+        http.delete.from(path).response do |response|
         end
       end
 
       def path
-        "/participants/#{email}"
+        "/participants/#{prop(:email).was || prop(:email).is}"
       end
 
       def fetch

data/lib/polleverywhere/serializable.rb

@@ -11,6 +11,22 @@ module PollEverywhere
     # for the fields that belond to a serializable model. Since a Property lives 
     # at the class level, we have a Value class that 
     class Property
+      # Manage a set of properties and easily create instances of values from them.
+      class Set < CoreExt::HashWithIndifferentAccess
+        # Create a set of of properties that we can use to create instances of value sets
+        def initialize
+          super() do |props, name|
+            props[name] = Property.new(name)
+          end
+        end
+
+        # Return a collection fo values wrapped inside of a valuset. Valuesets make
+        # it easier to query and validate a collection of values.
+        def value_set(hash={})
+          Value::Set.new(*values.map(&:value))
+        end
+      end
+
       include Configurable
 
       attr_accessor :name, :validations
@@ -32,45 +48,109 @@ module PollEverywhere
       # Contains the value of the property, runs validations, and
       # tracks property changes
       class Value
+        # Manage a collection of values so that you can validate, commit, detect changes, etc in bulk
+        class Set < CoreExt::HashWithIndifferentAccess
+          def initialize(*values, &block)
+            # Copy the values and property names into the hash
+            values.each do |value|
+              props[value.property.name] = value
+            end
+          end
+
+          # Set the current value so that we can track dirty changes
+          def []=(prop_name, value)
+            prop(prop_name).current = value
+          end
+
+          # Access the current value
+          def [](prop_name)
+            prop(prop_name).current
+          end
+
+          # Returns a hash with a {:attr => ['original', 'changed']}.
+          def changes
+            props.inject(CoreExt::HashWithIndifferentAccess.new) do |hash, (prop_name, value)|
+              hash[prop_name] = value.changes if value.changed?
+              hash
+            end
+          end
+
+          # Detects if all properties have been changed
+          def changed?
+            props.values.any?(&:changed?)
+          end
+
+          # Commit changes
+          def commit
+            props.values.each(&:commit)
+          end
+
+          # Our collection of property values... I call them props under the assumption that they're returning values.
+          def props
+            @props ||= CoreExt::HashWithIndifferentAccess.new do |hash, key|
+              hash[key] = Property.new(key).value
+            end
+          end
+
+          # Prettier way to get at a prop so it doesn't feel so hashy
+          def prop(prop_name)
+            props[prop_name]
+          end
+        end
+
         attr_reader :property, :original
         attr_accessor :current
+        # Make our value DSL prettier so we can ask, value.was and value.is
+        alias :is :current
+        alias :was :original
 
         def initialize(property)
           @property = property
         end
+
+        # Detect if the values have changed since we last updated them
+        def changed?
+          original != current
+        end
+
+        # The original and current state of the value if it changed.
+        def changes
+          [original, current] if changed?
+        end
+
+        # Commit the values if they're valid
+        def commit
+          @original = @current
+        end
       end
     end
 
     module ClassMethods
       # Set or get the root key of the model
       def root_key(name=nil)
-        name ? @name = name.to_sym : @name
+        name ? @root_key = name.to_sym : @root_key
       end
 
       # Define a property at the class level
       def prop(name, &block)
-        prop = props[name]
-        prop.instance_eval(&block) if block
-        prop
-      end
-
-      # Setup attributes hash and delegate setters/getters to the base class.
-      def props
-        @props ||= Hash.new do |props,name|
-          # Define the methods at the instance level
-          class_eval %{
-            def #{name}=(val)
-              props[:#{name}].current = val
-            end
-
-            def #{name}
-              props[:#{name}].current
-            end}
-          
-          # Setup the attribute class
-          props[name] = Property.new(name)
+        # Setup instance methods on the class that give us a short cut to the prop values
+        class_eval %{
+          def #{name}=(val)
+            value_set[:#{name}] = val
+          end
+
+          def #{name}
+            value_set[:#{name}]
+          end}
+        
+        prop_set[name].instance_eval(&block) if block
+        # Return the property we just created so we can chain calls
+        prop_set[name]
+      end
 
-        end.merge superclass_props
+      # A property set that inherits superclass property sets.
+      def prop_set
+        @prop_set ||= Property::Set.new.merge superclass_prop_set
       end
 
       # Instanciate a class from a hash
@@ -80,21 +160,29 @@ module PollEverywhere
 
     protected
       # Grab attributes from the superclass, clone them, and then we can modify them locally.
-      def superclass_props
-        (superclass.respond_to?(:props) && superclass.props.clone) || {}
+      def superclass_prop_set
+        (superclass.respond_to?(:prop_set) && superclass.prop_set.clone) || Property::Set.new
       end
     end
 
     module InstanceMethods
-      def props
-        @props ||= self.class.props.inject CoreExt::HashWithIndifferentAccess.new do |hash, (name, property)|
-          hash[property.name] = property.value
-          hash
-        end
+      # A value set instance for this class instance
+      def value_set
+        @value_set ||= self.class.prop_set.value_set
+      end
+
+      # Returns a value from the value_set for a property
+      def prop(name)
+        value_set.prop(name)
+      end
+
+      # Figure out if the model changed.
+      def changed?
+        value_set.changed?
       end
 
       def to_hash
-        hash = props.inject CoreExt::HashWithIndifferentAccess.new do |hash, (name, value)|
+        hash = value_set.props.inject CoreExt::HashWithIndifferentAccess.new do |hash, (name, value)|
           hash[name] = self.send(name)
           hash
         end
@@ -102,6 +190,13 @@ module PollEverywhere
         self.class.root_key ? { self.class.root_key => hash } : hash
       end
 
+      # Debug friendly way to output model state
+      def to_s
+        %(#{self.class.name}(#{value_set.props.map{|name, val|
+          "#{name}:#{'`' if val.changed? }#{val.current.inspect}"
+        }.join(', ')}))
+      end
+
       # Set the attributes from a hash
       def from_hash(hash)
         hash = CoreExt::HashWithIndifferentAccess.new(hash)

data/lib/polleverywhere/version.rb

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

data/spec/lib/models_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe PollEverywhere::Models::Participant do
+  before(:all) do
+    @p = PollEverywhere::Models::Participant.from_hash(:email => 'brad@brad.com')
+  end
+
+  context "email path" do
+    it "should have current email if not commited" do
+      @p.path.should eql('/participants/brad@brad.com')
+    end
+
+    it "should have old email if committed" do
+      @p.save
+      @p.email = 'super.duper@something.com'
+      @p.path.should eql('/participants/brad@brad.com')
+    end
+
+    it "should change email with old email in path" do
+      @p.save
+      @p.email = 'i.like.emails@something.com'
+      @p.path.should eql('/participants/super.duper@something.com')
+    end
+  end
+end

data/spec/lib/serializable_spec.rb

@@ -0,0 +1,161 @@
+require 'spec_helper'
+
+describe PollEverywhere::Serializable do
+  class Animal
+    include PollEverywhere::Serializable
+
+    prop :color
+    prop :smell
+    prop :name
+  end
+
+  class Furry < Animal
+    prop :fuzzy
+  end
+
+  before(:all) do
+    @bear = Furry.new.from_hash({
+      :fuzzy => true,
+      :name => 'Bear',
+      :small => 'awful',
+      :color => 'black'
+    })
+  end
+
+  context "property inheritence" do
+    it "should have subclass property" do
+      @bear.fuzzy.should be_true
+    end
+
+    it "should have superclass property" do
+      @bear.color.should eql('black')
+    end
+  end
+
+  context "property changes" do
+    it "should be changed" do
+      @bear.color = 'brown'
+      @bear.should be_changed
+    end
+  end
+
+  context "commit" do
+    before(:all) do
+      @bear.color = "red"
+      @bear.value_set.commit
+    end
+
+    it "should not be changed after commit" do
+      @bear.should_not be_changed
+    end
+
+    it "should have set current value as old value" do
+      @bear.prop(:color).was.should eql('red')
+    end
+
+    it "should have current value" do
+      @bear.prop(:color).is.should eql('red')
+    end
+
+    it "should not modify the old value" do
+      @bear.color = "green"
+      @bear.prop('color').was.should eql('red')
+      @bear.prop('color').is.should eql('green')
+    end
+  end
+end
+
+describe PollEverywhere::Serializable::Property do
+  before(:all) do
+    @prop = PollEverywhere::Serializable::Property.new(:field)
+  end
+
+  context "value" do
+    before(:each) do
+      @value = @prop.value
+    end
+    
+    it "should detect changes" do
+      @value.current = "super fun times"
+      @value.should be_changed
+    end
+
+    it "should maintain original value" do
+      @value.current = "flimtastical"
+      @value.original.should be_nil
+    end
+
+    context "after commit" do
+      before(:each) do
+        @value.current = "dog treats"
+        @value.commit
+      end
+
+      it "should not be changed" do
+        @value.should_not be_changed
+      end
+
+      it "should have original value" do
+        @value.current.should eql("dog treats")
+      end
+
+      it "should have current value" do
+        @value.current.should eql("dog treats")
+      end
+    end
+  end
+end
+
+describe PollEverywhere::Serializable::Property::Set do
+  before(:all) do
+    @propset = PollEverywhere::Serializable::Property::Set.new
+  end
+
+  it "should return properties for attributes" do
+    @propset[:first_name].should be_instance_of(PollEverywhere::Serializable::Property)
+  end
+
+  it "should return a Value::Set" do
+    @propset.value_set.should be_instance_of(PollEverywhere::Serializable::Property::Value::Set)
+  end
+end
+
+describe PollEverywhere::Serializable::Property::Value::Set do
+  context "changes" do
+    before(:each) do
+      @prop = PollEverywhere::Serializable::Property.new(:email)
+      @value_set = PollEverywhere::Serializable::Property::Value::Set.new(@prop.value)
+    end
+
+    context "property value" do
+      before(:each) do
+        @value_set[:email] = 'brad@bradgessler.com'
+      end
+
+      it "should have the current value" do
+        @value_set[:email].should eql('brad@bradgessler.com')
+      end
+
+      it "should have the original value" do
+        @value_set.prop(:email).was.should be_nil
+      end
+
+      it "should have changes for property value" do
+        was, is = @value_set.prop(:email).changes
+        was.should be_nil
+        is.should eql('brad@bradgessler.com')
+      end
+
+      it "should have changed" do
+        @value_set.prop(:email).should be_changed
+      end
+    end
+
+    context "hash" do
+      it "should return hash of changed value" do
+        @value_set[:email] = 'brad@bradgessler.com'
+        @value_set.changes[:email].should eql([nil, 'brad@bradgessler.com'])
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polleverywhere
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-12 00:00:00.000000000 -07:00
+date: 2011-07-15 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2156511940 !ruby/object:Gem::Requirement
+  requirement: &2156434260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156511940
+  version_requirements: *2156434260
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2156511340 !ruby/object:Gem::Requirement
+  requirement: &2156433200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *2156511340
+  version_requirements: *2156433200
 description: An easy way to integrate Poll Everywhere into your Ruby applications.
 email:
 - opensource@polleverywhere.com
@@ -68,7 +68,9 @@ files:
 - lib/polleverywhere/version.rb
 - polleverywhere.gemspec
 - spec/integration/api_spec.rb
+- spec/lib/models_spec.rb
 - spec/lib/polleverywhere_spec.rb
+- spec/lib/serializable_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://www.github.com/polleverywhere/polleverywhere
@@ -97,5 +99,7 @@ specification_version: 3
 summary: Integrate Poll Everywhere into your Ruby applications
 test_files:
 - spec/integration/api_spec.rb
+- spec/lib/models_spec.rb
 - spec/lib/polleverywhere_spec.rb
+- spec/lib/serializable_spec.rb
 - spec/spec_helper.rb