etherpad-lite 0.2.2 → 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e60ac28822b76594b6deefade5bc8dc793e7f8fda892862ed393061a8fc04d0
+  data.tar.gz: 6bdd88bd892d675dff75c9b44de75b751b84d446b75164fcc69d1f7edff60c6e
+SHA512:
+  metadata.gz: 04ddf7130b280b8c12d594d2db43e920b10bf9d691313acc98f91f9f529d78039bdb1df433dc784c77fbf0118d184617b824889eae29caeef0b9a576b009f4cb
+  data.tar.gz: f90d5cefeb797c74bd2862e12b697ac7cc4a376000fda82470a97e3a2064230e5926b15bc8e10efa3ca5b9636c50f06e75b1f8ebdf86f76ea8cb4a12ebd08f34

data/CHANGELOG

@@ -1,3 +1,16 @@
+** RELEASE 0.3.0 (2013-08-27) **
+
+* 100th commit, woot!
+* Target version 1.2.8 of API
+* Added EtherpadLite::API_VERSION constant to reflect the above
+* Added EtherpadLite::Pad#diff (EtherpadLite::Diff)
+* Added EtherpadLite::Pad#changeset
+
+** 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/README.rdoc

@@ -39,7 +39,7 @@ The above example deals with public pads, accessible to anyone through the Web U
 Examples are documented in EtherpadLite::Group, EtherpadLite::Author, and EtherpadLite::Session.
 
 == Example use in Rails
-For your view, I recommend the jQuery plugin at {github.com/johnyma22/etherpad-lite-jquery-plugin}[https://github.com/johnyma22/etherpad-lite-jquery-plugin].
+For your view, I recommend the jQuery plugin at {github.com/ether/etherpad-lite-jquery-plugin}[https://github.com/ether/etherpad-lite-jquery-plugin].
 Also, I recommend reading the docs for EtherpadLite::Group first.
 
 Add the following to your Gemfile
@@ -74,7 +74,7 @@ Some example controller actions:
       @group = ether.get_group(params[:ep_group_id])
       @pad = @group.pad(params[:ep_pad_name])
       # Map the user to an EtherpadLite Author
-      author = ether.author("my_app_user_#{current_user.id}", :name => current_user.name)
+      author = ether.author("my_app_user_#{current_user.id}", name: current_user.name)
       # Get or create an hour-long session for this Author in this Group
       sess = session[:ep_sessions][@group.id] ? ether.get_session(session[:ep_sessions][@group.id]) : @group.create_session(author, 60)
       if sess.expired?
@@ -83,7 +83,7 @@ Some example controller actions:
       end
       session[:ep_sessions][@group.id] = sess.id
       # Set the EtherpadLite session cookie. This will automatically be picked up by the jQuery plugin's iframe.
-      cookies[:sessionID] = {:value => sess.id, :domain => ".yourdomain.com"}
+      cookies[:sessionID] = {value: sess.id, domain: ".yourdomain.com"}
     end
   end
 

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,43 @@ 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
+      @ssl_verify = OpenSSL::SSL::VERIFY_PEER
+    end
+
+    # Whether peer must be verified if the API URL is SSL
+    def ssl_verify(mode)
+      @ssl_verify = mode
     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 +85,28 @@ 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::Request.execute(
+        :method  => :get,
+        :url     => "#{self.uri}#{path}",
+        :headers => {
+          :params => params
+        },
+        :verify_ssl=> @ssl_verify )
+    end
+
+    # Makes a POST request
+    def post(path, params={})
+      params[:apikey] = self.api_key
+      RestClient::Request.execute(
+        :method => :post,
+        :url    => "#{self.uri}#{path}",
+        :headers=> {},
+        :payload=> params,
+        :verify_ssl=> @ssl_verify )
+    end
   end
 end

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/diff.rb

@@ -0,0 +1,43 @@
+module EtherpadLite
+  # Represents a diff between two Pad revisions.
+  class Diff
+    # The EtherpadLite::Instance object
+    attr_accessor :instance
+    # The EtherpadLite::Pad object
+    attr_accessor :pad
+    # Diff start revision
+    attr_accessor :start_rev
+    # Diff end revision
+    attr_accessor :end_rev
+
+    # If end_rev is not specified, the latest revision will be used
+    def initialize(pad, start_rev, end_rev=nil)
+      @instance = pad.instance
+      @pad = pad
+      @start_rev = start_rev
+      @end_rev = end_rev || pad.revision_numbers.last
+    end
+
+    # Returns the diff as html
+    def html
+      diff[:html]
+    end
+
+    # Returns the IDs of the authors who were involved in the diff
+    def author_ids
+      diff[:authors]
+    end
+
+    # Returns Authors who were involved in the diff
+    def authors
+      @authors ||= author_ids.map { |id| Author.new(instance, id) }
+    end
+
+    private
+
+    # Queries and caches the diff
+    def diff
+      @diff ||= instance.client.createDiffHTML(padID: pad.id, startRev: start_rev, endRev: end_rev)
+    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

@@ -121,6 +121,16 @@ module EtherpadLite
       revision_numbers.map { |n| Pad.new(@instance, @id, :rev => n) }
     end
 
+    # Returns a Diff. If end_rev is not specified, the latest revision will be used
+    def diff(start_rev, end_rev=nil)
+      Diff.new(self, start_rev, end_rev)
+    end
+
+    # Returns the changeset for the given revision
+    def changeset(rev)
+      @instance.client.getRevisionChangeset(padID: @id, rev: rev)
+    end
+
     # Returns an array of users hashes, representing users currently using the pad
     def users
       @instance.client.padUsers(padID: @id)[:padUsers]
@@ -152,6 +162,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/models.rb

@@ -1,6 +1,8 @@
 require 'etherpad-lite/models/padded'
 require 'etherpad-lite/models/instance'
 require 'etherpad-lite/models/pad'
+require 'etherpad-lite/models/diff'
+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/version.rb

@@ -1,4 +1,6 @@
 module EtherpadLite
-  # The library version
-  VERSION = '0.2.2'
+  # Library version
+  VERSION = '0.3.1'
+  # API target version
+  API_VERSION = '1.2.8'
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: etherpad-lite
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 description: etherpad-lite is a Ruby interface to Etherpad Lite's HTTP JSON API
@@ -34,41 +31,41 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- CHANGELOG
+- LICENSE
+- README.rdoc
 - lib/etherpad-lite.rb
-- lib/etherpad-lite/models/padded.rb
-- lib/etherpad-lite/models/group.rb
-- lib/etherpad-lite/models/pad.rb
+- lib/etherpad-lite/client.rb
+- lib/etherpad-lite/models.rb
 - lib/etherpad-lite/models/author.rb
+- lib/etherpad-lite/models/chat_message.rb
+- lib/etherpad-lite/models/diff.rb
+- lib/etherpad-lite/models/group.rb
 - lib/etherpad-lite/models/instance.rb
+- lib/etherpad-lite/models/pad.rb
+- lib/etherpad-lite/models/padded.rb
 - lib/etherpad-lite/models/session.rb
-- lib/etherpad-lite/client.rb
 - lib/etherpad-lite/version.rb
-- lib/etherpad-lite/models.rb
-- README.rdoc
-- CHANGELOG
-- LICENSE
 homepage: http://github.com/jhollinger/ruby-etherpad-lite
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby client library for Etherpad Lite
 test_files: []