etherpad-lite 0.1.0.rc2 → 0.1.0

data/CHANGELOG

@@ -1,7 +1,7 @@
-** RELEASE 0.1.0 (Pending) **
+** RELEASE 0.1.0 (07/07/2012) **
 
 * Requires Etherpad Lite 1.1+
-* Added support for get/setHTML
+* Added support for getHTML, setHTML, listAuthorsOfPad, listPadsOfAuthor, getLastEdited, and padUsersCount
 * Uses POST for API calls which alter data - this allows much larger pad content to be written
 * Various minor improvements and bugfixes
 * More complete documentation and examples

data/lib/etherpad-lite.rb

@@ -1,2 +1,3 @@
+require 'etherpad-lite/version'
 require 'etherpad-lite/client'
 require 'etherpad-lite/models'

data/lib/etherpad-lite/client.rb

@@ -7,10 +7,6 @@ require 'json'
 BAD_RUBY = RUBY_VERSION < '1.9.0' # :nodoc:
 
 module EtherpadLite
-  MAJOR_VERSION, MINOR_VERSION, TINY_VERSION, PRE_VERSION = 0, 1, 0, 'rc2' # :nodoc:
-  # The client version
-  VERSION = [MAJOR_VERSION, MINOR_VERSION, TINY_VERSION, PRE_VERSION].compact.join '.'
-
   # An error returned by the server
   class APIError < StandardError
     MESSAGE = "Error while talking to the API (%s). Make sure you are running the latest version of the Etherpad Lite server. If that is not possible, try rolling this client back to an earlier version."
@@ -140,6 +136,10 @@ module EtherpadLite
       post :createAuthorIfNotExistsFor, params
     end
 
+    def listPadsOfAuthor(authorID)
+      get :listPadsOfAuthor, :authorID => authorID
+    end
+
     # Sessions
     # Sessions can be created between a group and an author. This allows
     # an author to access more than one group. The sessionID will be set as
@@ -214,6 +214,16 @@ module EtherpadLite
       get :getRevisionsCount, :padID => padID
     end
 
+    # Returns the number of users currently editing the pad
+    def padUsersCount(padID)
+      get :padUsersCount, :padID => padID
+    end
+
+    # Returns the time the pad was last edited as a Unix timestamp
+    def getLastEdited(padID)
+      get :getLastEdited, :padID => padID
+    end
+
     # Delete the given Pad
     def deletePad(padID)
       post :deletePad, :padID => padID
@@ -224,6 +234,10 @@ module EtherpadLite
       get :getReadOnlyID, :padID => padID
     end
 
+    def listAuthorsOfPad(padID)
+      get :listAuthorsOfPad, :padID => padID
+    end
+
     # Sets a boolean for the public status of a Pad
     def setPublicStatus(padID, publicStatus)
       post :setPublicStatus, :padID => padID, :publicStatus => publicStatus

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

@@ -80,6 +80,16 @@ module EtherpadLite
       @name = options[:name]
     end
 
+    # Returns an array of pad ids that this author has edited
+    def pad_ids
+      @instance.client.listPadsOfAuthor(@id)[:padIDs] || []
+    end
+
+    # Returns an array of Pads that this author has edited
+    def pads
+      pad_ids.map { |id| Pad.new(@instance, id) }
+    end
+
     # Create a new session for group that will last length_in_minutes.
     def create_session(group, length_in_min)
       Session.create(@instance, group.id, @id, length_in_min)

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

@@ -119,11 +119,32 @@ module EtherpadLite
       revision_numbers.map { |n| Pad.new(@instance, @id, :rev => n) }
     end
 
+    # Returns the number of users currently editing a pad
+    def user_count
+      @instance.client.padUsersCount(@id)[:padUsersCount]
+    end
+    alias_method :users_count, :user_count
+
     # Returns the Pad's read-only id. This is cached.
     def read_only_id
       @read_only_id ||= @instance.client.getReadOnlyID(@id)[:readOnlyID]
     end
 
+    # Returns the time the pad was last edited as a Unix timestamp
+    def last_edited
+      @instance.client.getLastEdited(@id)[:lastEdited]
+    end
+
+    # Returns an array of ids of authors who've edited this pad
+    def author_ids
+      @instance.client.listAuthorsOfPad(@id)[:authorIDs] || []
+    end
+
+    # Returns an array of Authors who've edited this pad
+    def authors
+      author_ids.map { |id| Author.new(@instance, id) }
+    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

@@ -0,0 +1,5 @@
+module EtherpadLite
+  MAJOR_VERSION, MINOR_VERSION, TINY_VERSION, PRE_VERSION = 0, 1, 0, nil # :nodoc:
+  # The client version
+  VERSION = [MAJOR_VERSION, MINOR_VERSION, TINY_VERSION, PRE_VERSION].compact.join '.'
+end

data/spec/author_spec.rb

@@ -21,4 +21,10 @@ describe EtherpadLite::Author do
     # They should be the same
     author1.id.should == author2.id
   end
+
+  it "should list pads of 'Author A'" do
+    author = @eth.create_author :mapper => 'Author A'
+    author.pad_ids.should == []
+    author.pads.should == []
+  end
 end

data/spec/config.yml

@@ -1,4 +1,3 @@
-:url: 9001
-:api_key: #kvwTIROV9p2h2gjNRCrO8fVa6pNXSqOc
-# Full filesystem path to APIKEY.txt, may be used instead of the above :api_key setting
+:url: 9003
+#:api_key: UrdBfgceHYDZs4yr1rQ12rVOzo31XfEW
 :api_key_file: /home/jhollinger/devel/etherpad-lite/APIKEY.txt

data/spec/pad_spec.rb

@@ -88,6 +88,22 @@ describe EtherpadLite::Pad do
     pad.text.should == "Brand new text\n"
   end
 
+  it "should list author ids" do
+    pad = @eth.pad 'brand new pad2'
+    pad.author_ids.should == []
+    pad.authors.should == []
+  end
+
+  it "should get the last edit date" do
+    pad = @eth.pad 'brand new pad3'
+    pad.last_edited.>(1).should == true
+  end
+
+  it "should return the number of users" do
+    pad = @eth.pad 'brand new pad3'
+    pad.user_count.should == 0
+  end
+
   it "should be deleted" do
     @eth.get_pad('another new pad').delete
     @eth.create_pad('another new pad').id.should_not == nil

metadata

@@ -1,65 +1,84 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: etherpad-lite
-version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
-  prerelease: 6
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000 Z
+
+date: 2012-07-07 00:00:00 -04:00
+default_executable: 
 dependencies: []
+
 description: etherpad-lite is a Ruby interface to Etherpad Lite's HTTP JSON API
 email: jordan@jordanhollinger.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.rdoc
-files:
+files: 
 - lib/etherpad-lite.rb
+- lib/etherpad-lite/models.rb
+- lib/etherpad-lite/models/session.rb
 - lib/etherpad-lite/models/padded.rb
-- lib/etherpad-lite/models/group.rb
-- lib/etherpad-lite/models/pad.rb
 - lib/etherpad-lite/models/author.rb
 - lib/etherpad-lite/models/instance.rb
-- lib/etherpad-lite/models/session.rb
+- lib/etherpad-lite/models/pad.rb
+- lib/etherpad-lite/models/group.rb
 - lib/etherpad-lite/client.rb
-- lib/etherpad-lite/models.rb
-- spec/pad_spec.rb
-- spec/config.yml.example
-- spec/config.yml
+- lib/etherpad-lite/version.rb
 - spec/spec_helper.rb
 - spec/instance_spec.rb
 - spec/session_spec.rb
-- spec/author_spec.rb
 - spec/group_spec.rb
+- spec/config.yml
+- spec/config.yml.example
+- spec/author_spec.rb
+- spec/pad_spec.rb
 - README.rdoc
 - CHANGELOG
 - LICENSE
+has_rdoc: true
 homepage: http://github.com/jhollinger/ruby-etherpad-lite
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>'
-    - !ruby/object:Gem::Version
-      version: 1.3.1
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby client library for Etherpad Lite
 test_files: []
+