etherpad-lite 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d745cb72cb181e73a58f018361f65076f5c71271
+  data.tar.gz: 37b34bf47ae14afd97d03bc68517ea6695a5bdea
+SHA512:
+  metadata.gz: 33430a5fffc2557c13305e928aa43ee9def25c0a77630af96ead8ed7ba099e1908395332581d028628ec9c9046089fd101ad787d5c1d5fe32a99b2760480c65f
+  data.tar.gz: 1377f2b2e7a8b4aacf4712e30b393b5bed5247c6f4fe3c3e73b2be7532de96f0b6b55a5b0c132089e96c9c012f96cf3fb9bbf733b82e11e1401e2cbb22852b21

data/CHANGELOG

@@ -1,3 +1,11 @@
+** 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

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

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/diff'
 require 'etherpad-lite/models/chat_message'
 require 'etherpad-lite/models/group'
 require 'etherpad-lite/models/author'

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/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]

data/lib/etherpad-lite/version.rb

@@ -1,4 +1,6 @@
 module EtherpadLite
-  # The library version
-  VERSION = '0.2.3'
+  # Library version
+  VERSION = '0.3.0'
+  # 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.3
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 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,42 +31,42 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
-- lib/etherpad-lite/models/author.rb
-- lib/etherpad-lite/models/session.rb
+- lib/etherpad-lite/client.rb
+- lib/etherpad-lite/version.rb
 - lib/etherpad-lite/models/group.rb
-- lib/etherpad-lite/models/pad.rb
 - lib/etherpad-lite/models/chat_message.rb
-- lib/etherpad-lite/models/instance.rb
 - lib/etherpad-lite/models/padded.rb
+- lib/etherpad-lite/models/pad.rb
+- lib/etherpad-lite/models/diff.rb
+- lib/etherpad-lite/models/author.rb
+- lib/etherpad-lite/models/instance.rb
+- lib/etherpad-lite/models/session.rb
 - lib/etherpad-lite/models.rb
-- lib/etherpad-lite/client.rb
-- lib/etherpad-lite/version.rb
 - lib/etherpad-lite.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: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby client library for Etherpad Lite
 test_files: []