wikidot-api 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michał Frąckowiak
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+Wikidot API Client Library for Ruby
+===================================
+
+Wikidot-api is a simple client library for [Wikidot Remote API](http://www.wikidot.com/doc:api).
+The library provides a simple wrapper around Ruby's [XMLRPC library](http://www.ensta.fr/~diam/ruby/online/ruby-doc-stdlib/libdoc/xmlrpc/rdoc/index.html) and handles authentication, reconnection and provides an easy way to access remote methods.
+
+Installation
+------------
+
+Wikidot-api is available as a gem. Installation is as simple as
+
+    gem install wikidot-api
+    
+(or run with <tt>sudo</tt> if your ruby installation requires it, i.e. <tt>sudo gem install wikidot-api</tt>)
+    
+Usage
+-----
+
+Before you start using the wikidot-api library, you need an API key. Please consult the original [documentation](http://www.wikidot.com/doc:api) on how to get one.
+
+### Connecting
+
+    require "rubygems"
+    require "wikidot_api"
+    
+    api_key = "YOUR_API_KEY_HERE"
+    user_name = "YOUR_USER_NAME_HERE"
+    
+    wikidot = WikidotAPI::Client.new 'wikidot-api', api_key
+    
+
+
+### Calling remote methods
+
+At this point the <tt>wikidot</tt> object should contain all methods described in the API documentation.
+The <tt>WikidotAPI::Client</tt> implements <tt>method_missing</tt> method so that every (non-defined) method you call
+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.
+
+#### 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.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']
+
+#### Example: Creating a new page
+
+    args = {
+        "title" => "My new page",
+        "source" => "Hello world from the new page",
+        "page" => "page-name",
+        "site" => "site-name"
+    }
+    
+    wikidot.page.save args
+    
+TODO
+----
+
+The library is a work-in-progress, as is the Wikidot API itself. Use at your own risk.
+    
+    
+See also
+--------
+
+- Wikidot.com at [http://www.wikidot.com](http://www.wikidot.com)
+- API documentation at [http://www.wikidot.com/doc:api](http://www.wikidot.com/doc:api)
+- list of available methods at [http://www.wikidot.com/doc:api-methods](http://www.wikidot.com/doc:api-methods)

data/lib/wikidot_api.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "xmlrpc/client"
+
+# Enable NIL extension to handle <nil/> values
+XMLRPC::Config::ENABLE_NIL_CREATE = true
+XMLRPC::Config::ENABLE_NIL_PARSER = true
+
+$: << File.dirname(__FILE__)
+
+require "wikidot_api/version"
+require "wikidot_api/client"

data/lib/wikidot_api/client.rb

@@ -0,0 +1,42 @@
+module WikidotAPI
+
+  # Wikidot API client class to handle XML-RPC api as described at
+  # http://www.wikidot.com/doc:api
+  class Client
+    def initialize app, key, opts={}
+      @app, @key = app, key
+      @domain = opts[:domain] || "www.wikidot.com"
+      @proto = opts[:proto] || "https" 
+    end
+
+    def call method, *args
+      try_count = 0
+      begin
+        server.call method, *args
+      rescue EOFError => e
+        @server = nil
+        try_count += 1
+        raise if try_count == 3
+        retry
+      end
+    end
+
+    def proxy(prefix=nil, *args)
+      XMLRPC::Client::Proxy.new(self, prefix, args, :call)
+    end
+
+    def method_missing method
+      proxy method.to_s
+    end
+
+    def server
+      @server ||= XMLRPC::Client.new2 endpoint_uri
+    end
+
+    def endpoint_uri
+      "#{@proto}://#{@app}:#{@key}@#{@domain}/xml-rpc-api.php"
+    end
+
+    private :server, :endpoint_uri
+  end
+end

data/lib/wikidot_api/version.rb

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: wikidot-api
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Micha\xC5\x82 Fr\xC4\x85ckowiak"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-22 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: |
+  Simple Ruby client library for Wikidot RPC API
+
+email: michalf@wikidot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- README.md
+- LICENSE
+- lib/wikidot_api/client.rb
+- lib/wikidot_api/version.rb
+- lib/wikidot_api.rb
+has_rdoc: true
+homepage: http://github.com/michalf/wikidot-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple Ruby client library for Wikidot RPC API
+test_files: []
+