rave 0.1.2-java

data/lib/models/document.rb

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,230 @@
+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

data/lib/models/operation.rb

@@ -0,0 +1,79 @@
+module Rave
+  module Models
+    # Represents an operation to be applied on the server.
+    class Operation # :nodoc:
+      attr_reader :index, :property
+
+      def type; @type.dup; end
+      def wave_id; @wave_id.dup; end
+      def wavelet_id; @wavelet_id.dup; end
+      def blip_id; @blip_id.dup; end
+      
+      JAVA_CLASS = 'com.google.wave.api.impl.OperationImpl' # :nodoc:
+      
+      #Constants
+      # Types of operations
+      WAVELET_APPEND_BLIP = 'WAVELET_APPEND_BLIP'
+      WAVELET_ADD_PARTICIPANT = 'WAVELET_ADD_PARTICIPANT'
+      WAVELET_REMOVE_PARTICIPANT = 'WAVELET_REMOVE_PARTICIPANT'
+      WAVELET_CREATE = 'WAVELET_CREATE'
+      WAVELET_REMOVE_SELF = 'WAVELET_REMOVE_SELF'
+      WAVELET_DATADOC_SET = 'WAVELET_DATADOC_SET'
+      WAVELET_SET_TITLE = 'WAVELET_SET_TITLE'
+      BLIP_CREATE_CHILD = 'BLIP_CREATE_CHILD'
+      BLIP_DELETE = 'BLIP_DELETE'
+      DOCUMENT_ANNOTATION_DELETE = 'DOCUMENT_ANNOTATION_DELETE'
+      DOCUMENT_ANNOTATION_SET = 'DOCUMENT_ANNOTATION_SET'
+      DOCUMENT_ANNOTATION_SET_NORANGE = 'DOCUMENT_ANNOTATION_SET_NORANGE'
+      DOCUMENT_APPEND = 'DOCUMENT_APPEND' # Plain text
+      DOCUMENT_APPEND_MARKUP = 'DOCUMENT_APPEND_MARKUP' # HTML
+      DOCUMENT_APPEND_STYLED_TEXT = 'DOCUMENT_APPEND_STYLED_TEXT'
+      DOCUMENT_INSERT = 'DOCUMENT_INSERT'
+      DOCUMENT_DELETE = 'DOCUMENT_DELETE'
+      DOCUMENT_REPLACE = 'DOCUMENT_REPLACE'
+      DOCUMENT_ELEMENT_APPEND = 'DOCUMENT_ELEMENT_APPEND'
+      DOCUMENT_ELEMENT_DELETE = 'DOCUMENT_ELEMENT_DELETE'
+      DOCUMENT_ELEMENT_INSERT = 'DOCUMENT_ELEMENT_INSERT'
+      DOCUMENT_ELEMENT_INSERT_AFTER = 'DOCUMENT_ELEMENT_INSERT_AFTER'
+      DOCUMENT_ELEMENT_INSERT_BEFORE = 'DOCUMENT_ELEMENT_INSERT_BEFORE'
+      DOCUMENT_ELEMENT_REPLACE = 'DOCUMENT_ELEMENT_REPLACE'
+      DOCUMENT_INLINE_BLIP_APPEND = 'DOCUMENT_INLINE_BLIP_APPEND'
+      DOCUMENT_INLINE_BLIP_DELETE = 'DOCUMENT_INLINE_BLIP_DELETE'
+      DOCUMENT_INLINE_BLIP_INSERT = 'DOCUMENT_INLINE_BLIP_INSERT'
+      DOCUMENT_INLINE_BLIP_INSERT_AFTER_ELEMENT = 'DOCUMENT_INLINE_BLIP_INSERT_AFTER_ELEMENT'
+
+      #Options include:
+      # - :type
+      # - :wave_id
+      # - :wavelet_id
+      # - :blip_id
+      # - :index
+      # - :property
+      def initialize(options = {})
+        @type = options[:type]
+        @wave_id = options[:wave_id]
+        @wavelet_id = options[:wavelet_id] || ''
+        @blip_id = options[:blip_id] || ''
+        @index = options[:index] || -1
+        @property = options[:property]
+      end
+      
+      #Serialize the operation to json
+      def to_json
+        hash = {
+          'blipId' => @blip_id,
+          'index' => @index,
+          'waveletId' => @wavelet_id,
+          'waveId' => @wave_id,
+          'type' => @type,
+          'javaClass' => JAVA_CLASS
+        }
+        
+        hash['property'] = @property unless @property.nil?
+        
+        hash.to_json
+      end
+    end
+  end
+end
+

data/lib/models/range.rb

@@ -0,0 +1,14 @@
+# Extend a standard Range so that it can be serialized easily
+
+class Range # :nodoc:
+  JAVA_CLASS = 'com.google.wave.api.Range'
+  
+  # Convert to a hash for sending in an operation.
+  def to_json
+    {
+      'javaClass' => JAVA_CLASS,
+      'start' => min,
+      'end' => max
+    }.to_json
+  end
+end