rave 0.1.1 → 0.1.2

data/lib/models/operation.rb

@@ -1,89 +1,79 @@
-#Represents an operation to be applied on the server
-module Rave
-  module Models
-    class Operation
-      attr_reader :type, :wave_id, :wavelet_id, :blip_id, :index, :property
-      
-      #Constants
-      # Types of operations
-      WAVELET_APPEND_BLIP = 'WAVELET_APPEND_BLIP'
-      WAVELET_ADD_PARTICIPANT = 'WAVELET_ADD_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'
-      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 hash
-      def to_hash
-        {
-          'blipId' => @blip_id,
-          'index' => @index,
-          'waveletId' => @wavelet_id,
-          'waveId' => @wave_id,
-          'type' => @type,
-          'javaClass' => 'com.google.wave.api.impl.OperationImpl',
-          'property' => property_to_hash
-        }
-      end
-      
-      #Serialize teh operation to json
-      def to_json
-        to_hash.to_json
-      end
-      
-    protected
-      #Decide what kind of property it is and return the value that should be in the JSON
-      def property_to_hash
-        if @property.kind_of?(String)
-          @property
-        elsif @property.kind_of?(Range)
-          {
-            'javaClass' => 'com.google.wave.api.Range',
-            'start' => @property.first,
-            'end' => @property.last
-          }
-        else
-          #TODO: What else needs to be in here?
-          raise "I don't know what that property is..."
-        end
-      end
-      
-    end
-  end
-end
+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

data/lib/models/robot.rb

@@ -1,61 +1,79 @@
-#Contains Robot data, event handlers and cron jobs
-module Rave
-  module Models
-    class Robot
-      include Rave::Mixins::DataFormat
-      include Rave::Mixins::Controller
-      
-      attr_reader :name, :image_url, :profile_url
-      
-      #Options include:
-      # - :name
-      # - :image_url
-      # - :profile_url
-      def initialize(options = {})
-        @name = options[:name]
-        @image_url = options[:image_url]
-        @profile_url = options[:profile_url]
-        @handlers = {}
-        @cron_jobs = []
-        register_default_handlers
-      end
-      
-      #Register a handler
-      # event_type is a string, and must be one of Rave::Models::Event::VALID_EVENTS
-      # multiple handlers may be applied to an event
-      def register_handler(event_type, handler)
-        raise Rave::InvalidEventException.new("Unknown event: #{event_type}") unless Rave::Models::Event.valid_event_type?(event_type)
-        raise Rave::InvalidHandlerException.new("Unknown handler: #{handler}") unless self.respond_to?(handler)
-        @handlers[event_type] ||= []
-        @handlers[event_type] << handler unless @handlers[event_type].include?(handler)
-      end
-      
-      #Dispatches events to the appropriate handler
-      def handle_event(event, context)
-        #Ignore unhandled events
-        if (handlers = @handlers[event.type])
-          handlers.each do |handler|
-            self.send(handler, event, context)
-          end
-        end
-      end
-      
-      #Registers a cron job
-      def register_cron_job(path, seconds)
-        @cron_jobs << {:path => path, :seconds => seconds}
-      end
-      
-    protected
-      #Register any handlers that are defined through naming convention
-      def register_default_handlers
-        Event::VALID_EVENTS.each do |event|
-          listener = event.downcase.to_sym
-          if respond_to?(listener)
-            register_handler(event, listener)
-          end
-        end
-      end
-      
-    end
-  end
+require 'singleton'
+require 'yaml'
+
+module Rave
+  module Models
+    # Contains Robot data, event handlers and cron jobs.
+    class Robot < User
+      include Rave::Mixins::DataFormat
+      include Rave::Mixins::Controller
+      include Singleton
+
+      CONFIG_FILE = 'config.yaml' # :nodoc:
+      
+      # Version of the robot, as in the yaml config [String]
+      def version # :nodoc:
+        @version.dup
+      end
+      
+      def initialize() # :nodoc:
+        config = config_from_file
+        super(config)
+        @handlers = {}
+        @cron_jobs = []
+        @version = config[:version] || '1'
+        register_default_handlers
+      end
+
+      # Read options from user-edited yaml config file.
+      def config_from_file # :nodoc:
+        config = YAML::load(File.open(CONFIG_FILE))
+        hash = {}
+        config['robot'].each_pair { |k, v| hash[k.to_sym] = v }
+        hash
+      end
+      
+      # Register a handler. Multiple handlers may be applied to a single event.
+      # +event_type+:: Must be one of Rave::Models::Event::*::TYPE [String]
+      def register_handler(event_type, handler)
+        raise Rave::InvalidEventException.new("Unknown event: #{event_type}") unless Rave::Models::Event.valid_type?(event_type)
+        raise Rave::InvalidHandlerException.new("Unknown handler: #{handler}") unless self.respond_to?(handler)
+        @handlers[event_type] ||= []
+        @handlers[event_type] << handler unless @handlers[event_type].include?(handler)
+      end
+      
+      #Dispatches events to the appropriate handler
+      def handle_event(event, context) # :nodoc:
+        #Ignore unhandled events
+        if (handlers = @handlers[event.type])
+          handlers.each do |handler|
+            self.send(handler, event, context)
+          end
+        end
+      end
+      
+      #Registers a cron job
+      def register_cron_job(handler, seconds)
+        @cron_jobs << { :path => "/_wave/cron/#{handler}", :handler => handler, :seconds => seconds }
+      end
+
+      # Creates a new wave with initial participants set.
+      # +participants+:: Humans and/or robots to start in the new wave [Array of String/User]
+      # Returns: The new wave, which contains a root wavelet which itself contains a root blip [Wave]
+      def create_wavelet(participants)
+        @context.create_wavelet(participants)
+      end
+      
+    protected
+      #Register any handlers that are defined through naming convention
+      def register_default_handlers # :nodoc:
+        Event.types.each do |type|
+          listener = type.downcase.to_sym
+          if respond_to?(listener)
+            register_handler(type, listener)
+          end
+        end
+      end
+    end
+  end
 end

data/lib/models/user.rb

@@ -0,0 +1,62 @@
+module Rave
+  module Models
+    # A wave client, acting as a wave creator, blip contributor and/or a wavelet participant.
+    class User < Component
+      ROBOT_PATTERN = /@appspot\.com$/ # :nodoc:
+      NOBODY_ID = "@@@nobody@@@" # :nodoc: Used as a default in certain circumstances.
+      
+      # Url link to the profile of the User [String].
+      # NOTE: Due to a limitation in Wave, for all users except the local robot
+      # the url will be empty.
+      def profile_url # :nodoc:
+        @profile_url.dup
+      end
+
+      # Url link to the image of the User [String].
+      # NOTE: Due to a limitation in Wave, for all users except the local robot
+      # the url will be empty.
+      def image_url # :nodoc:
+        @image_url.dup
+      end
+
+      # Unlike other components, Users are never generated [Boolean].
+      def generated? # :nodoc:
+        false
+      end
+
+      # - :id
+      # - :name
+      # - :profile_url
+      # - :image_url
+      # - :context
+      def initialize(options = {}) # :nodoc:
+        options[:id].downcase! if options[:id]
+        super(options)
+        @name = options[:name]
+        @profile_url = options[:profile_url] || ''
+        @image_url = options[:image_url] || ''
+      end
+
+      # Printable name of the User [String].
+      # NOTE: Due to a limitation in Wave, for all users except the local robot
+      # the name is the same as the @id.
+      def name # :nodoc:
+        @name || @id
+      end
+
+      # Is the User a robot client rather than a human client? [Boolean]
+      def robot? # :nodoc:
+        not (@id =~ ROBOT_PATTERN).nil?
+      end
+
+      # Convert to string [String]
+      def to_s
+        @id
+      end
+
+      def to_json # :nodoc:
+        @id.to_json
+      end
+    end
+  end
+end

data/lib/models/wave.rb

@@ -1,19 +1,45 @@
-# Represents a Wave
-module Rave
-  module Models
-    class Wave
-      attr_reader :id, :wavelet_ids
-      
-      attr_accessor :context
-      
-      #Options include:
-      # - :wavelet_ids
-      # - :id
-      def initialize(options = {})
-        @id = options[:id]
-        @wavelet_ids = Set.new(options[:wavelet_ids])
-      end
-      
-    end
-  end
-end
+module Rave
+  module Models
+    # Represents a Wave
+    class Wave < Component
+      # IDs for all wavelets that are part of the wave [Array of String]
+      def wavelet_ids # :nodoc:
+        @wavelet_ids.map { |id| id.dup }
+      end
+      
+      #Options include:
+      # - :wavelet_ids
+      # - :id
+      def initialize(options = {}) # :nodoc:
+        if options[:id].nil? and options[:context]
+          super(:id => "#{GENERATED_PREFIX}_wave_#{unique_id}", :context => options[:context])
+        else
+          super(options)
+        end
+
+        @wavelet_ids = options[:wavelet_ids] || []
+      end
+
+      # All wavelets that are part of the wave [Array of Wavelet]
+      def wavelets # :nodoc:
+        @wavelet_ids.map { |id| @context.wavelets[id] }
+      end
+
+      # The root wavelet (it will be nil if the event refers to a private subwavelet) [Wavelet]
+      def root_wavelet # :nodoc:
+        wavelets.find { |wavelet| wavelet and wavelet.root? }
+      end
+
+      def print_structure(indent = 0) # :nodoc:
+        str = ''
+        str << "#{'  ' * indent}Wave:#{@id}\n"
+
+        wavelets.each do |wavelet|
+          str << wavelet.print_structure(indent + 1)
+        end
+
+        str
+      end
+    end
+  end
+end