wikidot-api 0.0.1 → 0.0.2

data/README.md

@@ -24,11 +24,10 @@ Before you start using the wikidot-api library, you need an API key. Please cons
     require "wikidot_api"
     
     api_key = "YOUR_API_KEY_HERE"
-    user_name = "YOUR_USER_NAME_HERE"
     
-    wikidot = WikidotAPI::Client.new 'wikidot-api', api_key
+    wikidot = WikidotAPI::Client.new "wikidot-api", api_key
     
-
+First argument to the #new method is name of the application using the API. E.g. if you are creating an application called "Best Wikidot API Client", please use its name in the constructor.
 
 ### Calling remote methods
 
@@ -37,20 +36,43 @@ The <tt>WikidotAPI::Client</tt> implements <tt>method_missing</tt> method so tha
 is checked agains remote service. This way the library does not need to be updated if RPC methods change, but still provides
 convenient solution to query the remote service.
 
+#### Getting list of methods and method descriptions
+
+Using the RPC methods you can get list of implemented methods and their descriptions.
+
+    puts wikidot.system.listMethods
+
+at this moment this prints:
+    system.listMethods
+    system.methodHelp
+    system.methodSignature
+    system.multicall
+    site.pages
+    site.categories
+    page.get
+    page.files
+    page.save
+    user.valid
+    user.sites
+
+To print help about any particular method, try this:
+    
+    puts wikidot.system.methodHelp 'page.save'
+
 #### Example: Listing sites
 
 The example below uses the remote method <tt>user.sites</tt> that takes one parameter (<tt>user</tt>) and returns a list of sites that this user owns. The method can be called directly on the <tt>wikidot</tt> object.
 
-    sites = wikidot.user.sites 'user' => user_name
+    sites = wikidot.user.sites "user" => "YOUR_USER_NAME_HERE"
     sites.each do |site|
       puts "#{site["title"]}, http://#{site["name"]}.wikidot.com" 
     end
     
 #### Example: Fetching a page
 
-    page = wikidot.page.get 'site' => site, 'page' => page
-    puts page['title']
-    puts page['source']
+    page = wikidot.page.get "site" => "YOUR_SITE_NAME_HERE", "page" => "YOUR_PAGE_NAME_HERE"
+    puts page["title"]
+    puts page["source"]
 
 #### Example: Creating a new page
 

data/lib/wikidot_api/client.rb

@@ -5,15 +5,16 @@ module WikidotAPI
   class Client
     def initialize app, key, opts={}
       @app, @key = app, key
-      @domain = opts[:domain] || "www.wikidot.com"
-      @proto = opts[:proto] || "https" 
+      @host = opts[:host] || "www.wikidot.com"
+      @proto = opts[:proto] || "https"
+      @port = opts[:port] || false
     end
 
     def call method, *args
       try_count = 0
       begin
         server.call method, *args
-      rescue EOFError => e
+      rescue IOError => e
         @server = nil
         try_count += 1
         raise if try_count == 3
@@ -34,7 +35,7 @@ module WikidotAPI
     end
 
     def endpoint_uri
-      "#{@proto}://#{@app}:#{@key}@#{@domain}/xml-rpc-api.php"
+      "#{@proto}://#{@app}:#{@key}@#{@host}#{@port ? ':' + @port.to_s : ''}/xml-rpc-api.php"
     end
 
     private :server, :endpoint_uri

data/lib/wikidot_api/version.rb

@@ -1,3 +1,3 @@
 module WikidotAPI
-  Version = '0.0.1'
+  Version = '0.0.2'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wikidot-api
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Micha\xC5\x82 Fr\xC4\x85ckowiak"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 +02:00
+date: 2010-06-23 00:00:00 +02:00
 default_executable: 
 dependencies: []