etherpad-lite 0.2.0 → 0.2.1

data/CHANGELOG

@@ -1,4 +1,8 @@
-** RELEASE 0.2.0 (?) **
+** RELEASE 0.2.1 (2012-12-13) **
+
+* Support for the Etherpad Lite 1.2 release
+
+** RELEASE 0.2.0 (2012-09-29) **
 
 * Adds support for multiple API versions
 * Use rest_client

data/README.rdoc

@@ -2,7 +2,7 @@
 
 The etherpad-lite Ruby Gem is a Ruby client for Etherpad Lite's HTTP JSON API. Etherpad Lite is a collaborative editor provided by the {Etherpad Foundation}[http://etherpad.org].
 
-See {github.com/Pita/etherpad-lite}[https://github.com/Pita/etherpad-lite] for information on how to install and configure your own Etherpad Lite instance, and read {github.com/Pita/etherpad-lite/wiki/HTTP-API}[https://github.com/Pita/etherpad-lite/wiki/HTTP-API] for an in-depth description of Etherpad Lite's HTTP API.
+See {github.com/ether/etherpad-lite}[https://github.com/ether/etherpad-lite] for information on how to install and configure your own Etherpad Lite instance, and read {etherpad.org/doc/v1.2.0/#index_http_api}[http://etherpad.org/doc/v1.2.0/#index_http_api] for an in-depth description of Etherpad Lite's HTTP API.
 
 == Installation
     gem install etherpad-lite
@@ -34,8 +34,6 @@ See {github.com/Pita/etherpad-lite}[https://github.com/Pita/etherpad-lite] for i
       puts pad_rev.text
     end
 
-Full docs are at {jordanhollinger.com/docs/ruby-etherpad-lite/}[http://jordanhollinger.com/docs/ruby-etherpad-lite/]
-
 == Advanced usage
 The above example deals with public pads, accessible to anyone through the Web UI. There is another class of pads - group pads - which deal with groups, authors and sessions.
 Examples are documented in EtherpadLite::Group, EtherpadLite::Author, and EtherpadLite::Session.
@@ -101,7 +99,7 @@ or you can explicitly load just the low-level client:
     client = EtherpadLite.client('http://beta.etherpad.org/api', 'api key', 1.1)
     client.setText(padID: 'my first etherpad lite pad', text: "lots of new text and stuff")
 
-The methods and parameters exactly match the HTTP API. For a full list of them, see {github.com/Pita/etherpad-lite/wiki/HTTP-API}[https://github.com/Pita/etherpad-lite/wiki/HTTP-API].
+The methods and parameters exactly match the HTTP API. For a full list of them, see {etherpad.org/doc/v1.2.0/#index_http_api}[http://etherpad.org/doc/v1.2.0/#index_http_api].
 
 == Testing
 Testing this library is fairly simple. It requires:

data/lib/etherpad-lite/client.rb

@@ -4,7 +4,7 @@ require 'rest_client'
 
 # A client library for Etherpad Lite's JSON API. 
 # 
-# A thin wrapper around the HTTP API. See the API documentation at https://github.com/Pita/etherpad-lite/wiki/HTTP-API.
+# A thin wrapper around the HTTP API. See the API documentation at http://etherpad.org/doc/v1.2.0/#index_api_methods.
 # 
 #  client = EtherpadLite.client('http://localhost:9001', 'api key', '1.1')
 #  client.getText(:padID => 'foo')
@@ -31,7 +31,7 @@ module EtherpadLite
     Client.new(url_or_port, api_key_or_file, api_version)
   end
 
-  # A thin wrapper around Etherpad Lite's HTTP JSON API. See the API documentation at https://github.com/Pita/etherpad-lite/wiki/HTTP-API.
+  # A thin wrapper around Etherpad Lite's HTTP JSON API. See the API documentation at http://etherpad.org/doc/v1.2.0/#index_api_methods.
   class Client
     # A URI object containing the URL of the Etherpad Lite instance
     attr_reader :uri

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

@@ -188,6 +188,11 @@ module EtherpadLite
       @instance.client.setPassword(padID: @id, password: new_password)
     end
 
+    # Sends a custom message of type msg to the pad.
+    def message(msg)
+      @instance.client.sendClientsMessage(padID: @id, msg: msg)
+    end
+
     # Deletes the Pad
     def delete
       @instance.client.deletePad(padID: @id)

data/lib/etherpad-lite/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: etherpad-lite
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-07 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -44,14 +44,6 @@ files:
 - lib/etherpad-lite/client.rb
 - lib/etherpad-lite/version.rb
 - lib/etherpad-lite/models.rb
-- spec/pad_spec.rb
-- spec/config.yml.example
-- spec/config.yml
-- spec/spec_helper.rb
-- spec/instance_spec.rb
-- spec/session_spec.rb
-- spec/author_spec.rb
-- spec/group_spec.rb
 - README.rdoc
 - CHANGELOG
 - LICENSE
@@ -75,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby client library for Etherpad Lite

data/spec/author_spec.rb

@@ -1,37 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe EtherpadLite::Author do
-  before do
-    @eth = EtherpadLite.connect TEST_CONFIG[:url], TEST_CONFIG[:api_key_file] || TEST_CONFIG[:api_key], TEST_CONFIG[:api_version]
-  end
-
-  it "should be created" do
-    author = @eth.create_author
-    author.id.nil?.should == false
-  end
-
-  it "should be mapped to 'Author A'" do
-    author = @eth.create_author :mapper => 'Author A'
-    author.id.nil?.should == false
-  end
-
-  it "should be mapped to 'Author A'" do
-    author1 = @eth.create_author :mapper => 'Author A'
-    author2 = @eth.author 'Author A'
-    # 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
-
-  if TEST_CONFIG[:api_version] > 1
-    it "should get the name" do
-      author = @eth.create_author :mapper => 'Author B', :name => 'Jim Jimmers'
-      author.name.should == 'Jim Jimmers'
-    end
-  end
-end

data/spec/config.yml

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

data/spec/config.yml.example

@@ -1,5 +0,0 @@
-:url: http://localhost:9001
-:api_key: your api key
-# Full filesystem path to APIKEY.txt, may be used instead of the above :api_key setting
-:api_key_file:
-:api_version: 1.1

data/spec/group_spec.rb

@@ -1,141 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe EtherpadLite::Group do
-  before do
-    @eth = EtherpadLite.connect TEST_CONFIG[:url], TEST_CONFIG[:api_key_file] || TEST_CONFIG[:api_key], TEST_CONFIG[:api_version]
-  end
-
-  it "should be created" do
-    group = @eth.create_group
-    group.id.nil?.should == false
-  end
-
-  it "should be mapped to 'Group A'" do
-    group = @eth.create_group :mapper => 'Group A'
-    group.id.nil?.should == false
-  end
-
-  it "should be mapped to 'Group A'" do
-    group1 = @eth.create_group :mapper => 'Group A'
-    group2 = @eth.group 'Group A'
-    # They should be the same
-    group1.id.should == group2.id
-  end
-
-  it "should create a Group Pad" do
-    group = @eth.group 'Group A'
-    pad = group.pad 'Important Group Stuff'
-    pad.id.should == "#{group.id}$Important Group Stuff"
-  end
-
-  it "should create another Group Pad" do
-    group = @eth.group 'Group A'
-    pad = @eth.create_pad 'Other Important Group Stuff', :groupID => group.id, :text => 'foo'
-    pad.text.should == "foo\n"
-  end
-
-  it "should create a Group Pad with the right name" do
-    group = @eth.group 'Group A'
-    pad = group.pad 'Important Group Stuff'
-    pad.name.should == "Important Group Stuff"
-  end
-
-  it "should find a Group Pad with the right group" do
-    group = @eth.group 'Group A'
-    group.get_pad('Important Group Stuff').group_id.should == group.id
-  end
-
-  it "should find another Group Pad with the right group" do
-    group = @eth.group 'Group A'
-    @eth.get_pad('Other Important Group Stuff', :groupID => group.id).group_id.should == group.id
-  end
-
-  it "should find yet another Group Pad with the right group" do
-    group = @eth.group 'Group A'
-    @eth.get_pad("Other Important Group Stuff", :groupID => group.id).text.should == "foo\n"
-  end
-
-  it "should find another Group Pad with the right text" do
-    group = @eth.group 'Group A'
-    @eth.get_pad("#{group.id}$Other Important Group Stuff").text.should == "foo\n"
-  end
-
-  it "should find yet another Group Pad with the right text" do
-    group = @eth.group 'Group A'
-    @eth.get_pad("#{group.id}$Other Important Group Stuff").text.should == "foo\n"
-  end
-
-  it "should find a Group Pad with the right ids" do
-    group = @eth.group 'Group A'
-    group.pad_ids.should == ["#{group.id}$Important_Group_Stuff", "#{group.id}$Other_Important_Group_Stuff"]
-  end
-
-  it "should find a Group Pad with the right name" do
-    group = @eth.group 'Group A'
-    group.pads.first.name.should == "Important_Group_Stuff"
-  end
-
-  it "should explicitly create a Group Pad" do
-    group = @eth.group 'Group A'
-    pad = group.create_pad 'new group pad', :text => 'abc'
-    pad.text.should == "abc\n"
-  end
-
-  if TEST_CONFIG[:api_version] > 1
-    it "should list all group ids" do
-      group_ids = @eth.group_ids
-      group_ids.size.should == 4
-    end
-
-    it "should list all groups" do
-      groups = @eth.groups
-      groups.size.should == 4
-      groups.first.class.name.should == 'EtherpadLite::Group'
-    end
-  end
-
-  context 'Group Pad' do
-    context 'Privacy' do
-      it "should be private" do
-        group = @eth.group 'Group A'
-        pad = group.get_pad 'new group pad'
-        pad.private?.should == true
-      end
-
-      it "should not be public" do
-        group = @eth.group 'Group A'
-        pad = group.get_pad 'new group pad'
-        pad.public?.should == false
-      end
-
-      it "should change to public" do
-        group = @eth.group 'Group A'
-        pad = group.get_pad 'new group pad'
-        pad.public = true
-        pad.public?.should == true
-      end
-
-      it "should change to not private" do
-        group = @eth.group 'Group A'
-        pad = group.get_pad 'new group pad'
-        pad.private = false
-        pad.private?.should == false
-      end
-    end
-
-    context 'Password' do
-      it "should not have a password" do
-        group = @eth.group 'Group A'
-        pad = group.get_pad 'new group pad'
-        pad.password?.should == false
-      end
-
-      it "should have a password set" do
-        group = @eth.group 'Group A'
-        pad = group.get_pad 'new group pad'
-        pad.password = 'correct horse battery staple'
-        pad.password?.should == true
-      end
-    end
-  end
-end

data/spec/instance_spec.rb

@@ -1,12 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe EtherpadLite::Instance do
-  before do
-    @eth = EtherpadLite.connect TEST_CONFIG[:url], TEST_CONFIG[:api_key_file] || TEST_CONFIG[:api_key], TEST_CONFIG[:api_version]
-  end
-
-  it "should have the right API key" do
-    api_key = TEST_CONFIG[:api_key_file] || TEST_CONFIG[:api_key]
-    @eth.client.api_key.should == api_key
-  end
-end

data/spec/pad_spec.rb

@@ -1,128 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe EtherpadLite::Pad do
-  before do
-    @eth = EtherpadLite.connect TEST_CONFIG[:url], TEST_CONFIG[:api_key_file] || TEST_CONFIG[:api_key], TEST_CONFIG[:api_version]
-  end
-
-  it "should blow up when querying a non-existing pad" do
-    pad = @eth.get_pad 'a non-existant pad'
-    begin
-      txt = pad.text
-    rescue EtherpadLite::Error => e
-    end
-    e.message.should == 'padID does not exist'
-  end
-
-  it "should create a new pad" do
-    pad = @eth.create_pad 'my new pad', :text => 'The initial text'
-    pad.text.should == "The initial text\n"
-  end
-
-  it "should blow up when creating a Pad that already exists" do
-    begin
-      pad = @eth.create_pad 'my new pad', :text => 'The initial text'
-    rescue EtherpadLite::Error => e
-    end
-    e.message.should == 'padID does already exist'
-  end
-
-  it "should automatically create a Pad" do
-    pad = @eth.pad 'another new pad'
-    pad.text = "The initial text"
-    pad.text.should == "The initial text\n"
-  end
-
-  it "should automatically find a Pad" do
-    pad = @eth.pad 'another new pad'
-    pad.text.should == "The initial text\n"
-  end
-
-  it "should find a Pad" do
-    pad = @eth.get_pad 'another new pad'
-    pad.text.should == "The initial text\n"
-  end
-
-  it "should have a read-only id" do
-    pad = @eth.get_pad 'another new pad'
-    pad.read_only_id.should =~ /^r\.\w+/
-  end
-
-  it "should add revisions" do
-    pad = @eth.get_pad 'another new pad'
-    pad.text == "New text"
-    pad.revision_numbers.last == 2
-  end
-
-  it "should set HTML" do
-    pad = @eth.get_pad 'another new pad'
-    pad.html = "<div><p>Here's some HTML.</p>\n<p>Please rewind it when you're finished.</p></div>"
-    pad.html.should == "Here&#x27;s some HTML.<br>Please rewind it when you&#x27;re finished.<br>"
-  end
-
-  it "should have the first revision" do
-    pad = @eth.get_pad 'another new pad'
-    pad.text(:rev => 1).should == "The initial text\n"
-  end
-
-  it "should have the first revision" do
-    pad = @eth.get_pad 'another new pad'
-    pad.revisions[1].text.should == "The initial text\n"
-  end
-
-  it "should have the first revision as HTML" do
-    pad = @eth.get_pad 'another new pad'
-    pad.revisions[1].html.should == "The initial text<br>"
-  end
-
-  it "should have the same name and id" do
-    pad = @eth.get_pad 'another new pad'
-    pad.name.should == pad.id
-  end
-
-  it "should be initialized as revision 0" do
-    pad = @eth.pad 'brand new pad', :text => 'Brand new text'
-    pad.text = 'Even newer text'
-    pad.text = 'Even even newer text'
-    pad = @eth.get_pad 'brand new pad', :rev => 0
-    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 not crash when setting null text" do
-    err_msg = nil
-    begin
-      @eth.client.setText(:padID => 'brand new pad3')
-    rescue EtherpadLite::Error => e
-      err_msg = e.message
-    end
-    err_msg.should == 'text is no string'
-  end
-
-  it "should be deleted" do
-    @eth.get_pad('another new pad').delete
-    @eth.create_pad('another new pad').id.should_not == nil
-  end
-
-  if TEST_CONFIG[:api_version] > 1
-    it "should get the pad users" do
-      puts @eth.pad('pad with users').users
-      @eth.pad('pad with users').users.should == []
-    end
-  end
-end

data/spec/session_spec.rb

@@ -1,45 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-describe EtherpadLite::Session do
-  before do
-    @eth = EtherpadLite.connect TEST_CONFIG[:url], TEST_CONFIG[:api_key_file] || TEST_CONFIG[:api_key], TEST_CONFIG[:api_version]
-  end
-
-  it "should be created for a Group" do
-    group = @eth.group 'Maycomb'
-    author = @eth.author 'Atticus'
-    session = group.create_session(author, 20)
-    session.valid_until.should == Time.now.to_i + 20 * 60
-  end
-
-  it "should be created for an Author" do
-    group = @eth.group 'Maycomb'
-    author = @eth.author 'Scout'
-    session = author.create_session(group, 15)
-    session.valid_until.should == Time.now.to_i + 15 * 60
-  end
-
-  it "should be found in a Group" do
-    group = @eth.group 'Maycomb'
-    author = @eth.author 'Atticus'
-    group.sessions.map(&:author_id).include?(author.id).should == true
-  end
-
-  it "shouldn be found in a Group" do
-    group = @eth.group 'Maycomb'
-    author = @eth.author 'Atticus'
-    author.sessions.map(&:group_id).include?(group.id).should == true
-  end
-
-  it "shouldn't be found in the wrong Group" do
-    group = @eth.group 'Other group'
-    author = @eth.author 'Scout'
-    group.sessions.map(&:author_id).include?(author.id).should == false
-  end
-
-  it "shouldn't be found in the wrong Group" do
-    group = @eth.group 'Other group'
-    author = @eth.author 'Scout'
-    author.sessions.map(&:group_id).include?(group.id).should == false
-  end
-end

data/spec/spec_helper.rb

@@ -1,14 +0,0 @@
-require 'rspec'
-
-# Load etherpad-lite
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/..'
-require 'etherpad-lite'
-
-RSpec.configure do |c|
-  c.mock_with :rspec
-end
-
-# Load test config
-require 'yaml'
-TEST_CONFIG = YAML.load_file(File.dirname(__FILE__) + '/config.yml')
-TEST_CONFIG[:api_key_file] = File.open(TEST_CONFIG[:api_key_file], &:read) unless TEST_CONFIG[:api_key_file].nil?