rave 0.1.1 → 0.1.2

data/lib/models/component.rb

@@ -0,0 +1,42 @@
+module Rave
+  module Models
+    # A wave or wave component.
+    # This is an abstract class.
+    class Component
+      include Rave::Mixins::Logger
+      
+      GENERATED_PREFIX = 'TBD' # :nodoc: Prefixes blips and wavelets that are created by the robot.
+      GENERATED_PATTERN = /^#{GENERATED_PREFIX}/ # :nodoc:
+
+      @@last_id = 0 # For generated components, this is a unique ID number for them.
+      
+      attr_writer :context # :nodoc: Allow context to set link to it.
+
+      # Has this component been generated by the robot [Boolean]
+      def generated? # :nodoc:
+        # This is true for all components except Users, who would override this.
+        not (@id =~ /^#{GENERATED_PREFIX}/).nil?
+      end
+
+      # Generate a unique id number (from 1) [Integer]
+      def unique_id # :nodoc:
+        @@last_id += 1
+      end
+
+      # ID [String]
+      def id # :nodoc:
+        @id.dup
+      end
+      
+      def initialize(options = {}) # :nodoc:
+        @id = options[:id] or raise ArgumentError.new(":id option is required for #{self.class.name}")
+        @context = options[:context]
+      end
+
+      # Convert to string.
+      def to_s
+        "#{self.class.name[/[^:]*$/]}:#{@id}"
+      end
+    end
+  end
+end

data/lib/models/context.rb

@@ -1,45 +1,174 @@
-#Contains server request information including current waves and operations
-module Rave
-  module Models
-    class Context
-      attr_reader :waves, :wavelets, :blips, :operations
-      
-      #Options include:
-      # - :waves
-      # - :wavelets
-      # - :blips
-      # - :operations
-      def initialize(options = {})
-        @waves = options[:waves] || {}
-        @waves.values.each { |wave| wave.context = self }          #Set up self as this wave's context
-        @wavelets = options[:wavelets] || {}
-        @wavelets.values.each { |wavelet| wavelet.context = self } #Set up self as this wavelet's context
-        @blips = options[:blips] || {}
-        @blips.values.each { |blip| blip.context = self }          #Set up self as this blip's context
-        @operations = options[:operations] || []
-      end
-      
-      #Find the root wavelet if it exists in this context
-      def root_wavelet
-        @wavelets.values.find { |wavelet| wavelet.id =~ Regexp.new(Rave::Models::Wavelet::ROOT_ID_REGEXP) }
-      end
-      
-      #Serializes the context to JSON format
-      def to_json
-        self.to_hash.to_json
-      end
-      
-      #Serialize the context to a hash map
-      def to_hash
-        hash = {
-          'operations' => { 'javaClass' => 'java.util.ArrayList', 'list' => [] },
-          'javaClass' => 'com.google.wave.api.impl.OperationMessageBundle'
-         }
-        @operations.each do |op|
-          hash['operations']['list'] << op.to_hash
-        end
-        hash
-      end
-    end
-  end
-end
+module Rave
+  module Models
+    # Contains server request information including current waves and operations.
+    class Context
+
+      attr_reader :primary_wavelet # :nodoc: API users should use Event#wavelet
+      attr_reader :robot # The robot managing this context.
+
+      # All waves by ID [Hash of String => Wave]
+      def waves # :nodoc:
+        @waves.dup
+      end
+
+      # All wavelets by ID [Hash of String => Wavelet]
+      def wavelets # :nodoc:
+        @wavelets.dup
+      end
+
+      # All wavelets by ID [Hash of String => Wavelet]
+      def blips # :nodoc:
+        @blips.dup
+      end
+
+      # All operations [Array of Operation]
+      def operations # :nodoc:
+        @operations.dup
+      end
+
+      # All users by ID [Hash of String => User]
+      def users # :nodoc:
+        @users.dup
+      end
+      
+      JAVA_CLASS = 'com.google.wave.api.impl.OperationMessageBundle' # :nodoc:
+      
+      #Options include:
+      # - :waves
+      # - :wavelets
+      # - :blips
+      # - :operations
+      # - :users
+      def initialize(options = {}) # :nodoc:
+        @waves = options[:waves] || {}
+        @waves.values.each { |wave| wave.context = self }          #Set up self as this wave's context
+
+        @wavelets = options[:wavelets] || {}
+        @wavelets.values.each { |wavelet| wavelet.context = self } #Set up self as this wavelet's context
+        @primary_wavelet = @wavelets.values[0] # As opposed to any that are created later.
+
+        
+        @blips = options[:blips] || {}
+        @blips.values.each { |blip| blip.context = self }          #Set up self as this blip's context
+        
+        @operations = options[:operations] || []
+        
+        @users = options[:users] || {}
+        @users.values.each { |user| user.context = self }          #Set up self as this user's context
+
+        resolve_user_references(options[:robot])
+      end
+
+    protected
+      # Create users for every reference to one in the wave.
+      def resolve_user_references(robot) # :nodoc:
+        if robot
+          @users[robot.id] = robot
+          robot.context = self
+          @robot = robot
+        end
+        
+        @wavelets.each_value do |wavelet|
+          wavelet.participant_ids.each do |id|
+            unless @users[id]
+              add_user(:id => id)
+            end
+          end
+          
+          unless @users[wavelet.creator_id]
+            add_user(:id => wavelet.creator_id)
+          end
+        end
+        
+        @blips.each_value do |blip|
+          blip.contributor_ids.each do |id|
+            unless @users[id]
+              add_user(:id => id)
+            end
+          end
+        end
+      end
+
+    public
+      # Add a blip to blips (Use an Operation to actually add the blip to the Wave).
+      # Returns: The blip [Blip].
+      def add_blip(blip) # :nodoc:
+        @blips[blip.id] = blip
+        blip.context = self
+        blip
+      end
+
+      # Add an operation to the list to be executed.
+      # Returns: self [Context]
+      def add_operation(options) # :nodoc:
+        @operations << Operation.new(options)
+        self
+      end
+
+      # Add a wavelet to wavelets (Use an Operation to actually add the blip to the Wave).
+      # Returns: The wavelet [Wavelet].
+      def add_wavelet(wavelet)# :nodoc:
+        @wavelets[wavelet.id] = wavelet
+        wavelet.context = self
+        wavelet
+      end
+
+      # Add a wave to waves (Use an Operation to actually add the wave).
+      # Returns: The wave [Wave].
+      def add_wave(wave)# :nodoc:
+        @waves[wave.id] = wave
+        wave.context = self
+        wave
+      end
+
+      # +participants+:: Participants to exist in the new wavelet, as IDs or objects [Array of String/User]
+      # Returns: Newly created wave [Wave]
+      def create_wavelet(participants) # :nodoc:
+        # Map participants to strings, since they could be Users.
+        participant_ids = participants.map {|p| p.to_s.downcase }
+        participant_ids << @robot.id unless participant_ids.include? @robot.id
+        
+        wavelet = Wavelet.new(:context => self, :participants => participant_ids)
+        add_wavelet(wavelet)
+
+        # TODO: Get wave id from sensible place?
+        add_operation(:type => Operation::WAVELET_CREATE, :wave_id => @waves.keys[0],
+          :property => wavelet)
+
+        wavelet
+      end
+
+      # Remove a blip.
+      def remove_blip(blip) # :nodoc:
+        @blips.delete(blip.id)
+      end
+
+      # Add a user to users (Use an Operation to actually add the blip to the Wave).
+      def add_user(options) # :nodoc:
+        options[:id].downcase! if options[:id]
+        raise DuplicatedIDError.new("Can't add another User with id #{options[:id]}") if @users.has_key? options[:id].downcase
+        user = User.new(options)
+        @users[user.id] = user
+        user.context = self
+        user
+      end
+           
+      #Serialize the context for use in the line protocol.
+      def to_json # :nodoc:
+        hash = {
+          'operations' => { 'javaClass' => 'java.util.ArrayList', 'list' => @operations },
+          'javaClass' => JAVA_CLASS
+        }
+        hash.to_json
+      end
+
+      def print_structure(indent = 0) # :nodoc:
+        str = ''
+        waves.each_value do |wave|
+          str << wave.print_structure(indent)
+        end
+        str
+      end
+    end
+  end
+end

data/lib/models/document.rb

@@ -1,9 +1,9 @@
-module Rave
-  module Models
-    class Document
-      
-      #TODO
-      
-    end
-  end
+module Rave
+  module Models
+    class Document # :nodoc:
+      
+      #TODO
+      
+    end
+  end
 end

data/lib/models/element.rb

@@ -0,0 +1,113 @@
+module Rave
+  module Models
+    # An element within a document.
+    # (abstract factory)
+    class Element < Component
+      include Rave::Mixins::ObjectFactory
+
+      JAVA_CLASS = "com.google.wave.api.FormElement"
+
+      def initialize(properties = {})
+        super(:id => '') # TODO: Don't actually have IDs, as such. Bad inheritance from Component?
+        @properties = properties
+      end
+
+      # Gets the value of an element property.
+      def get(key, default = nil)
+        if @properties.has_key? key
+          @properties[key]
+        else
+          default
+        end
+      end
+
+      # Sets the value of an element property.
+      def set(key, value)
+        @properties[key] = value
+      end
+
+      # Alias for #set(key, value)
+      alias_method :[]=, :set
+
+      # Alias for #get(key)
+      alias_method :[], :get
+
+      def to_json # :nodoc:
+        {
+          'javaClass' => JAVA_CLASS,
+          'properties' => @properties,
+          'type' => type,
+        }.to_json
+      end
+
+      # A Google Gadget element within a document.
+      class Gadget < Element
+        factory_register 'GADGET'
+
+        def initialize(fields = {})
+          # Gadget has 'fields' rather than 'properties'.
+          super(fields)
+        end
+      end
+
+      # An image element within a document.
+      class Image < Element
+        factory_register 'IMAGE'
+      end
+
+      # An inline blip within a document.
+      class InlineBlip < Element
+        factory_register 'INLINE_BLIP'
+
+        # The blip contained within the element [Blip].
+        def blip # :nodoc:
+          @context.blips[@properties['blipId']]
+        end
+      end
+
+      # A form element within a document.
+      # (Abstract)
+      class Form < Element
+        # A button form element within a document.
+        class Button < Form
+          factory_register 'BUTTON'
+        end
+
+        # A check form element within a document.
+        class Check < Form
+          factory_register 'CHECK'
+        end
+
+        # A input form element within a document.
+        class Input < Form
+          factory_register 'INPUT'
+        end
+
+        # A password form element within a document.
+        class Password < Form
+          factory_register 'PASSWORD'
+        end
+
+        # A label form element within a document.
+        class Label < Form
+          factory_register 'LABEL'
+        end
+
+        # A radio button form element within a document.
+        class RadioButton < Form
+          factory_register 'RADIO_BUTTON'
+        end
+
+        # A radio button group form element within a document.
+        class RadioButtonGroup < Form
+          factory_register 'RADIO_BUTTON_GROUP'
+        end
+
+        # A text-area form element within a document.
+        class TextArea < Form
+          factory_register 'TEXTAREA'
+        end
+      end
+    end
+  end
+end

data/lib/models/event.rb

@@ -1,48 +1,230 @@
-#Represents and event
-module Rave
-  module Models
-    class Event
-      attr_reader :type, :timestamp, :modified_by, :properties
-      
-      #Event types:
-      WAVELET_BLIP_CREATED = 'WAVELET_BLIP_CREATED'
-      WAVELET_BLIP_REMOVED = 'WAVELET_BLIP_REMOVED'
-      WAVELET_PARTICIPANTS_CHANGED = 'WAVELET_PARTICIPANTS_CHANGED'
-      WAVELET_TIMESTAMP_CHANGED = 'WAVELET_TIMESTAMP_CHANGED'
-      WAVELET_TITLE_CHANGED = 'WAVELET_TITLE_CHANGED'
-      WAVELET_VERSION_CHANGED = 'WAVELET_VERSION_CHANGED'
-      BLIP_CONTRIBUTORS_CHANGED = 'BLIP_CONTRIBUTORS_CHANGED'
-      BLIP_DELETED = 'BLIP_DELETED'
-      BLIP_SUBMITTED = 'BLIP_SUBMITTED'
-      BLIP_TIMESTAMP_CHANGED = 'BLIP_TIMESTAMP_CHANGED'
-      BLIP_VERSION_CHANGED = 'BLIP_VERSION_CHANGED'
-      DOCUMENT_CHANGED = 'DOCUMENT_CHANGED'
-      FORM_BUTTON_CLICKED = 'FORM_BUTTON_CLICKED'
-      
-      VALID_EVENTS = [
-              WAVELET_BLIP_CREATED, WAVELET_BLIP_REMOVED, WAVELET_PARTICIPANTS_CHANGED,
-              WAVELET_TIMESTAMP_CHANGED, WAVELET_TITLE_CHANGED, WAVELET_VERSION_CHANGED,
-              BLIP_CONTRIBUTORS_CHANGED, BLIP_DELETED, BLIP_SUBMITTED, BLIP_TIMESTAMP_CHANGED,
-              BLIP_VERSION_CHANGED, DOCUMENT_CHANGED, FORM_BUTTON_CLICKED
-           ]
-      
-      #Options include:
-      # - :type
-      # - :timestamp
-      # - :modified_by
-      # - :properties
-      def initialize(options = {})
-        @type = options[:type]
-        @timestamp = options[:timestamp] || Time.now
-        @modified_by = options[:modified_by]
-        @properties = options[:properties] || {}
-      end
-      
-      #Returns true if the event_type is a possible event type, and false if not
-      def self.valid_event_type?(event_type)
-        VALID_EVENTS.include?(event_type)
-      end
-      
-    end
-  end
-end
+module Rave
+  module Models
+    # Represents an event received from the server.
+    class Event
+      include Rave::Mixins::TimeUtils
+      include Rave::Mixins::ObjectFactory
+
+      BLIP_ID = 'blipId' # :nodoc:
+      
+      # Time at which the event was created [Time]
+      def timestamp # :nodoc:
+        @timestamp.dup
+      end
+
+      # ID of the blip that caused the event, or root blip of the wavelet that caused the event [String]
+      def blip_id # :nodoc:
+        @properties[BLIP_ID].dup
+      end
+
+      # Wavelet that caused the event, or wavelet containing the blip that caused the event [Wavelet]
+      def wavelet # :nodoc:
+        @context.primary_wavelet
+      end
+
+      # The user that caused this event to be generated [User]
+      def modified_by # :nodoc:
+        @context.users[@modified_by_id]
+      end
+
+      # Blip that caused the event, or wavelet's root blip for wavelet events [Blip]
+      def blip # :nodoc:
+        @context.blips[@properties[BLIP_ID]]
+      end
+
+      #Options include:
+      # - :timestamp
+      # - :modified_by
+      # - :properties
+      # - :context
+      # Do not use Event.new from outside; instead use Event.create
+      def initialize(options = {}) # :nodoc:
+        @timestamp = time_from_json(options[:timestamp]) || Time.now
+        @modified_by_id = options[:modified_by] || User::NOBODY_ID
+        @properties = options[:properties] || {}
+        @context = options[:context]
+
+        raise ArgumentError.new(":context option required") if @context.nil?
+
+        add_user_ids([@modified_by_id])
+      end
+
+    protected
+      # Add a series of user ids to the context, if they don't already exist.
+      def add_user_ids(user_ids) # :nodoc:
+        user_ids.each do |id|
+          @context.add_user(:id => id) unless @context.users[id]
+        end
+      end
+      
+      # Wavelet events
+
+    public
+      class WaveletBlipCreated < Event
+        factory_register 'WAVELET_BLIP_CREATED'
+        
+        # Newly created blip [Blip]
+        def new_blip # :nodoc:
+          @context.blips[@properties['newBlipId']]
+        end
+      end
+      
+      class WaveletBlipRemoved < Event
+        factory_register 'WAVELET_BLIP_REMOVED'
+        
+        # ID for blip which has now been removed [String]
+        def removed_blip_id # :nodoc:
+          @properties['removedBlipId'].dup
+        end
+      end
+      
+      class WaveletParticipantsChanged < Event
+        factory_register 'WAVELET_PARTICIPANTS_CHANGED'
+
+        ADDED = 'participantsAdded' # :nodoc:
+        REMOVED = 'participantsRemoved' # :nodoc:
+
+        def initialize(options = {}) # :nodoc:
+          super(options)
+          
+          add_user_ids(@properties[ADDED]) if @properties[ADDED]
+          add_user_ids(@properties[REMOVED]) if @properties[REMOVED]
+        end
+        
+        # Array of participants added to the wavelet [Array of User]
+        def participants_added # :nodoc:
+          @properties[ADDED].map { |id| @context.users[id] }
+        end
+        
+        # Array of participants removed from the wavelet [Array of User].
+        def participants_removed # :nodoc:
+          @properties[REMOVED].map { |id| @context.users[id] }
+        end
+      end
+      
+      class WaveletSelfAdded < Event
+        factory_register 'WAVELET_SELF_ADDED'
+      end
+      
+      class WaveletSelfRemoved < Event
+        factory_register 'WAVELET_SELF_REMOVED'
+      end
+      
+      class WaveletTimestampChanged < Event
+        factory_register 'WAVELET_TIMESTAMP_CHANGED'
+
+        # Time that the wavelet was changed [Time]
+        def new_timestamp # :nodoc:
+          @properties['timestamp'].dup
+        end
+      end
+      
+      class WaveletTitleChanged < Event
+        factory_register 'WAVELET_TITLE_CHANGED'
+
+        def new_title # :nodoc:
+          @properties['title'].dup
+        end
+      end
+            
+      class WaveletVersionChanged < Event
+        factory_register 'WAVELET_VERSION_CHANGED'
+
+        def new_version # :nodoc:
+          @properties['version'].dup
+        end
+      end
+      
+      # Blip events
+      
+      class BlipContributorsChanged < Event
+        factory_register 'BLIP_CONTRIBUTORS_CHANGED'
+
+        ADDED = 'contributorsAdded' # :nodoc:
+        REMOVED = 'contributorsRemoved' # :nodoc:
+
+        def initialize(options = {}) # :nodoc:
+          super(options)
+
+          add_user_ids(@properties[ADDED]) if @properties[ADDED]
+          add_user_ids(@properties[REMOVED]) if @properties[REMOVED]
+        end
+
+        # Array of contributors added to the wavelet [Array of User].
+        def contributors_added # :nodoc:
+          @properties[ADDED].map { |id| @context.users[id] }
+        end
+        
+        # Array of contributors removed from the wavelet [Array of User].
+        def contributors_removed # :nodoc:
+          @properties[REMOVED].map { |id| @context.users[id] }
+        end
+      end
+      
+      class BlipSubmitted < Event
+        factory_register 'BLIP_SUBMITTED'
+      end
+
+      # #blip will be nil, but #blip_id will give a sensible value.
+      class BlipDeleted < Event
+        factory_register 'BLIP_DELETED'
+
+        # ID of the blip that was deleted [String]
+        #-- This dummy method just added for the purposes of rdoc.
+        def blip_id # :nodoc:
+          super
+        end
+
+        def initialize(options = {}) # :nodoc:
+          super(options)
+
+          # Ensure a referenced blip is properly deleted. Destroyed blip won't exist.
+          blip.delete_me(false) if @properties[BLIP_ID] and blip
+        end
+      end
+      
+      # General events.
+      
+      class DocumentChanged < Event
+        factory_register 'DOCUMENT_CHANGED'
+      end
+      
+      class FormButtonClicked < Event
+        factory_register 'FORM_BUTTON_CLICKED'
+        
+        # Name of button that was clicked.
+        def button # :nodoc:
+          @properties['button'].dup
+        end
+      end
+
+      # Generated when someone in the current wave creates a new wavelet (in a new wave).
+      class WaveletCreated < Event
+        factory_register 'WAVELET_CREATED'
+      end
+
+      class OperationError < Event
+        factory_register 'OPERATION_ERROR'
+
+        # Message describing what caused the error [String]
+        def message # :nodoc:
+          @properties['errorMessage'].dup
+        end
+
+        # Operation type that caused the error [String]
+        def operation_type # :nodoc:
+          # Format is "document.appendMarkup1260632282946" (number is timestamp)
+          @properties['operationId'] =~ /^(.+?)\d+$/
+          "#{$1.split(/(?=[A-Z])|\./).join('_').upcase}"
+        end
+
+        # Time of the err [String]
+        def operation_timestamp # :nodoc:
+          # Format is "document.appendMarkup1260632282946" (number is timestamp)
+          @properties['operationId'] =~ /(\d+)$/
+          time_from_json($1)
+        end
+      end
+    end
+  end
+end