etherpad-lite 0.2.2 → 0.2.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+** RELEASE 0.2.3 (2013-04-11) **
+
+* Add support for Chat API
+* Default to the latest supported API version on the server
+
 ** RELEASE 0.2.2 (2013-01-20) **
 
 * Support for Etherpad Lite API v1.2.1

data/lib/etherpad-lite/client.rb

@@ -27,7 +27,7 @@ module EtherpadLite
   #  client = EtherpadLite.client('https://etherpad.yoursite.com', 'your api key', '1.1')
   # 
   #  client = EtherpadLite.client(9001, 'your api key', '1.1') # Alias to http://localhost:9001
-  def self.client(url_or_port, api_key_or_file, api_version=1)
+  def self.client(url_or_port, api_key_or_file, api_version=nil)
     Client.new(url_or_port, api_key_or_file, api_version)
   end
 
@@ -41,31 +41,37 @@ module EtherpadLite
     attr_reader :api_version
 
     # Instantiate a new Etherpad Lite Client. You may pass a full url or just a port number. The api key may be a string
-    # or a File object. If you do not specify an API version, it will default to the latest version that is supported.
-    def initialize(url_or_port, api_key_or_file, api_version=1)
+    # or a File object. If you do not specify an API version, it will default to the latest version.
+    def initialize(url_or_port, api_key_or_file, api_version=nil)
       url_or_port = "http://localhost:#{url_or_port}" if url_or_port.is_a? Integer
       @uri = URI.parse(url_or_port)
       @api_key = api_key_or_file.is_a?(IO) ? api_key_or_file.read : api_key_or_file
-      @api_version = api_version.to_s
+      @api_version = api_version ? api_version.to_s : current_api_version.to_s
     end
 
     # Call an API method
     def method_missing(method, params={})
-      request = method =~ /^(set|create|delete)/ \
-        ? ->(url, params) { RestClient.post(url, params) } \
-        : ->(url, params) { RestClient.get(url, :params => params) }
-      call(method, params, &request)
+      call(method, params)
     end
 
     private
 
+    # Returns the latest api version. Defaults to "1" if anything goes wrong.
+    def current_api_version
+      JSON.parse(get('/api').to_s)['currentVersion'] rescue 1
+    end
+
     # Calls the EtherpadLite API and returns the :data portion of the response Hash.
     # If the API response contains an error code, an exception is raised.
     def call(api_method, params={}, &request)
-      params[:apikey] = @api_key
-      url = [@uri.to_s, 'api', self.api_version, api_method].compact.join('/')
-      json = request.(url, params).to_s
-      response = JSON.parse(json, :symbolize_names => true)
+      path = "/api/#{api_version}/#{api_method}"
+
+      begin
+        result = api_method =~ /^(set|create|delete)/ ? post(path, params) : get(path, params)
+        response = JSON.parse(result.to_s, :symbolize_names => true)
+      rescue JSON::ParserError => e
+        raise Error, "Unable to parse JSON response: #{json}"
+      end
 
       case response[:code]
         when 0 then response[:data]
@@ -73,5 +79,17 @@ module EtherpadLite
         else raise Error, "An unknown error ocurrced while handling the API response: #{response.to_s}"
       end
     end
+
+    # Makes a GET request
+    def get(path, params={})
+      params[:apikey] = self.api_key
+      RestClient.get("#{self.uri}#{path}", :params => params)
+    end
+
+    # Makes a POST request
+    def post(path, params={})
+      params[:apikey] = self.api_key
+      RestClient.post("#{self.uri}#{path}", params)
+    end
   end
 end

data/lib/etherpad-lite/models.rb

@@ -1,6 +1,7 @@
 require 'etherpad-lite/models/padded'
 require 'etherpad-lite/models/instance'
 require 'etherpad-lite/models/pad'
+require 'etherpad-lite/models/chat_message'
 require 'etherpad-lite/models/group'
 require 'etherpad-lite/models/author'
 require 'etherpad-lite/models/session'

data/lib/etherpad-lite/models/chat_message.rb

@@ -0,0 +1,61 @@
+module EtherpadLite
+  # An Etherpad Lite Chat message
+  class ChatMessage
+    # The EtherpadLite::Instance object
+    attr_reader :instance
+    # The pad id
+    attr_reader :pad_id
+    # The message text
+    attr_reader :text
+    # User/Author id
+    attr_reader :user_id
+    # Unix timestamp
+    attr_reader :timestamp
+    # User/Author name
+    attr_reader :user_name
+
+    # Instantiate a ChatMessage
+    def initialize(instance, attrs)
+      @instance = instance
+      @pad_id = attrs[:padID]
+      @text = attrs[:text]
+      @user_id = attrs[:userId]
+      @timestamp = attrs[:time] / 1000 if attrs[:time]
+      @user_name = attrs[:userName]
+    end
+
+    # Returns this message's Pad
+    def pad
+      if pad_id
+        @pad ||= Pad.new(instance, pad_id)
+      else
+        nil
+      end
+    end
+
+    # Returns the Author that sent this message
+    def author
+      if user_id
+        @author ||= Author.new(instance, user_id)
+      else
+        nil
+      end
+    end
+
+    alias_method :user, :author
+
+    # Time object
+    def time
+      if timestamp
+        @time ||= Time.at(timestamp)
+      else
+        nil
+      end
+    end
+
+    # Returns the message text
+    def to_s
+      text.to_s
+    end
+  end
+end

data/lib/etherpad-lite/models/instance.rb

@@ -4,7 +4,7 @@ module EtherpadLite
   #  ether = EtherpadLite.client('https://etherpad.yoursite.com', 'your api key', '1.1')
   # 
   #  ether = EtherpadLite.client(9001, 'your api key', '1.1') # Alias to http://localhost:9001
-  def self.connect(url_or_port, api_key_or_file, api_version=1)
+  def self.connect(url_or_port, api_key_or_file, api_version=nil)
     Instance.new(url_or_port, api_key_or_file, api_version)
   end
 
@@ -16,7 +16,7 @@ module EtherpadLite
 
     # Instantiate a new Etherpad Lite Instance. You may pass a full url or just a port number. The api key may be a string
     # or a File object.
-    def initialize(url_or_port, api_key_or_file, api_version=1)
+    def initialize(url_or_port, api_key_or_file, api_version=nil)
       @client = Client.new(url_or_port, api_key_or_file, api_version)
     end
 

data/lib/etherpad-lite/models/pad.rb

@@ -152,6 +152,20 @@ module EtherpadLite
       author_ids.map { |id| Author.new(@instance, id) }
     end
 
+    # Returns an array of chat message Hashes
+    def chat_messages(start_index=nil, end_index=nil)
+      messages = @instance.client.getChatHistory(:padID => @id, :start => start_index, :end => end_index)[:messages]
+      messages.map do |msg|
+        attrs = {padID: @id}.merge(msg)
+        ChatMessage.new(@instance, attrs)
+      end
+    end
+
+    # Returns the number of chat messages
+    def chat_size
+      @instance.client.getChatHead(padID: @id)[:chatHead] + 1
+    end
+
     # Returns true if this is a public Pad (opposite of private?).
     # This only applies to Pads belonging to a Group.
     def public?

data/lib/etherpad-lite/version.rb

@@ -1,4 +1,4 @@
 module EtherpadLite
   # The library version
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etherpad-lite
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -34,16 +34,17 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- lib/etherpad-lite.rb
-- lib/etherpad-lite/models/padded.rb
+- lib/etherpad-lite/models/author.rb
+- lib/etherpad-lite/models/session.rb
 - lib/etherpad-lite/models/group.rb
 - lib/etherpad-lite/models/pad.rb
-- lib/etherpad-lite/models/author.rb
+- lib/etherpad-lite/models/chat_message.rb
 - lib/etherpad-lite/models/instance.rb
-- lib/etherpad-lite/models/session.rb
+- lib/etherpad-lite/models/padded.rb
+- lib/etherpad-lite/models.rb
 - lib/etherpad-lite/client.rb
 - lib/etherpad-lite/version.rb
-- lib/etherpad-lite/models.rb
+- lib/etherpad-lite.rb
 - README.rdoc
 - CHANGELOG
 - LICENSE