etherpad-lite 0.0.1 → 0.0.2

data/CHANGELOG

@@ -0,0 +1,7 @@
+** RELEASE 0.0.2 (09/05/2011) **
+
+* Bugfix to Pad#private=, documentation updates
+
+** RELEASE 0.0.1 (08/30/2011) **
+
+* Initial release

data/README.rdoc

@@ -10,8 +10,8 @@ See https://github.com/Pita/etherpad-lite for information on how to install and
 == 2 Basic usage
     require 'etherpad-lite'
 
-    # Connect to your Etherpad Lite instance (passing no arguments will connect you to beta.etherpad.org)
-    ether = EtherpadLite.connect('http://etherpad-lite.example.com', 'your api key')
+    # Connect to your Etherpad Lite instance
+    ether = EtherpadLite.connect('http://etherpad-lite.example.com', 'the api key')
 
     # Get a Pad (or create one if it doesn't exist)
     pad = ether.pad('my first etherpad lite pad')
@@ -35,7 +35,7 @@ See https://github.com/Pita/etherpad-lite for information on how to install and
 For advanced functionality (i.e. Groups, Authors, Sessions), read the full docs at http://jordanhollinger.com/docs/ruby-etherpad-lite/. Also, the RSpec tests under /spec may provide some pointers.
 
 == 3 Why is the Ruby client so different from the others? What gives you the right?!?
-The PHP and Python clients are extremely thin wrappers of the HTTP API; their method names map directly to urls. The Ruby client offers a slightly higher level of abstration,
+The PHP and Python clients are extremely thin wrappers around the HTTP API; their method names map directly to urls. The Ruby client offers a slightly higher level of abstration,
 with the goal of making Etherpad Lite integration in Ruby projects as simple, poweful, and dare I say fun, as possible.
 
 That said, there is certainly value in supporting the defacto standard set by the PHP and Python clients. With that in mind, the Ruby client is written in two layers, 

data/lib/etherpad-lite/client.rb

@@ -4,7 +4,7 @@ require 'net/https'
 require 'json'
 
 module EtherpadLite
-  # A thin wrapper over Etherpad Lite's HTTP JSON API
+  # A thin wrapper around Etherpad Lite's HTTP JSON API
   class Client
     API_VERSION = 1
 
@@ -25,7 +25,7 @@ module EtherpadLite
     # Manually set path to the system's CA certs. Use this if the location couldn't be determined automatically.
     def self.ca_path=(path); @@ca_path = path; end
 
-    # Instantiate a new Etherpad Lite Instance. The url should include the protocol (i.e. http or https).
+    # Instantiate a new Etherpad Lite Client. The url should include the protocol (i.e. http or https).
     def initialize(api_key, url='http://localhost:9001/api')
       @uri = URI.parse(url)
       raise ArgumentError, "#{url} is not a valid url" unless @uri.host and @uri.port
@@ -33,7 +33,7 @@ module EtherpadLite
       connect!
     end
 
-    # Pad, Group, etc. all use this to send the HTTP API requests.
+    # Calls the EtherpadLite API and returns the :data portion of the response Hash.
     def call(method, params={})
       # Build path
       params[:apikey] = @api_key
@@ -226,4 +226,4 @@ end
 %w{/etc/ssl/certs /etc/ssl /usr/share/ssl /usr/lib/ssl /System/Library/OpenSSL /usr/local/ssl}.each do |path|
   EtherpadLite::Client.ca_path = path and break if File.exists? path
 end
-$stderr.puts %q|WARNING Unable to find your CA Certificates; HTTPS connections will *not* be verified! You may remedy this with "EtherpadLite::Instance.ca_path = '/path/to/certs'"| unless EtherpadLite::Client.ca_path
+$stderr.puts %q|WARNING Ruby etherpad-lite client was unable to find your CA Certificates; HTTPS connections will *not* be verified! You may remedy this with "EtherpadLite::Client.ca_path = '/path/to/certs'"| unless EtherpadLite::Client.ca_path

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

@@ -8,8 +8,6 @@ module EtherpadLite
   # ether1 = EtherpadLite.connect('https://etherpad.yoursite.com[https://etherpad.yoursite.com]', 'your api key')
   # 
   # ether2 = EtherpadLite.connect(:local, File.new('/file/path/to/APIKEY.txt'))
-  # 
-  # ether3 = EtherpadLite.connect(:public, "beta.etherpad.org's api key")
   def self.connect(host_or_alias, api_key_or_file)
     # Parse the host
     host = if host_or_alias.is_a? Symbol

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

@@ -75,7 +75,7 @@ module EtherpadLite
       @instance.client.setText(@id, txt)
     end
 
-    # Returns a Range of all this Pad's revision numbers
+    # Returns an Array of all this Pad's revision numbers
     def revision_numbers
       max = @instance.client.getRevisionsCount(@id)[:revisions]
       (0..max).to_a
@@ -91,7 +91,7 @@ module EtherpadLite
       @read_only_id ||= @instance.client.getReadOnlyID(@id)[:readOnlyID]
     end
 
-    # Returns true if this is a public Pad (opposite of private).
+    # Returns true if this is a public Pad (opposite of private?).
     # This only applies to Pads belonging to a Group.
     def public?
       @instance.client.getPublicStatus(@id)[:publicStatus]
@@ -103,16 +103,16 @@ module EtherpadLite
       @instance.client.setPublicStatus(@id, status)
     end
 
-    # Returns true if this is a private Pad (opposite of public)
+    # Returns true if this is a private Pad (opposite of public?)
     # This only applies to Pads belonging to a Group.
     def private?
-      not public?
+      not self.public?
     end
 
     # Set the pad's private status to true or false (opposite of public=)
     # This only applies to Pads belonging to a Group.
     def private=(status)
-      public = !status
+      self.public = !status
     end
 
     # Returns true if this Pad has a password, false if not.

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

@@ -42,10 +42,12 @@ module EtherpadLite
       get_info[:validUntil]
     end
 
+    # Returns true if the session is not expired
     def valid?
       valid_until < Time.now.to_i
     end
 
+    # Returns true if the session is expired
     def expired?
       not valid?
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jordan Hollinger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-30 00:00:00 -04:00
+date: 2011-09-05 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -45,9 +45,10 @@ files:
 - spec/author_spec.rb
 - spec/pad_spec.rb
 - README.rdoc
+- CHANGELOG
 - LICENSE
 has_rdoc: true
-homepage: http://github.com/jhollinger/etherpad-lite
+homepage: http://github.com/jhollinger/ruby-etherpad-lite
 licenses: []
 
 post_install_message: