eXistAPI 0.0.0

data/lib/collection.rb

@@ -0,0 +1,59 @@
+require "xmlrpc/client"
+require 'document'
+
+class Collection
+
+  attr_reader :name
+  attr_reader :owner
+  attr_reader :group
+  attr_reader :permissions
+  attr_reader :childCollection
+    
+  def initialize(client, collectionName)
+    @client = client
+    load(collectionName)
+  rescue  => e
+    raise e  
+  end
+
+  def to_s()
+    return "#{@permissions} #{@owner} #{@group} #{@name}"
+  end
+
+  def documents
+    @documents.each { |d| yield d }
+  end
+  
+  def docs    #returns string array of all documents in collection
+    ds = []
+    @documents.each{ |d| ds.push(d.name)}
+    return ds
+  end
+
+  def [](key)
+    @documents.each { |d|
+      return d if key == d.name 
+    }
+    return nil
+  end
+
+  protected
+
+  def load(collectionName)
+    resp = @client.call("getCollectionDesc", collectionName)
+    @name = resp['name']+"/"
+    @owner = resp['owner']
+    @group = resp['group']
+    @permissions = resp['permissions']
+    @childCollection = resp['collections']
+            
+    @documents = Array.new
+    docs = resp['documents']
+    #puts "docs #{docs}"
+    docs.each { |d| @documents.push(Document.new(@client, d, @name)) }
+  rescue XMLRPC::FaultException => e
+    raise e
+  rescue
+    raise ExistException.new("Failed to load Collection", 10), callers
+  end #end def load
+end #end class Collection

data/lib/document.rb

@@ -0,0 +1,34 @@
+class Document
+
+  attr_reader :path
+  attr_reader :name
+  attr_reader :owner
+  attr_reader :group
+  attr_reader :permissions
+
+  def initialize(client, hash, colname)
+    @client = client
+    @path = colname + hash['name']
+    @name = @path[/[^\/]+$/]
+    #puts "filename #{@name}"
+    @owner = hash['owner']
+    @group = hash['group']
+    @permissions = hash['permissions']
+  rescue  => e
+    raise e  
+  end
+
+  def to_s
+    return "#{@permissions} #{@owner} #{@group} #{@name}"
+  end
+
+  def content
+    options = { "indent" => "yes", "encoding" => "UTF-8",
+      "expand-xincludes" => "yes" }
+    return @client.call("getDocument", @path, options)
+  rescue XMLRPC::FaultException => e
+    raise e
+  rescue
+    raise ExistException.new("Failed to load content of Document", 11), callers
+  end
+end

data/lib/eXistAPI.rb

@@ -0,0 +1,209 @@
+require "xmlrpc/client"
+require 'collection'
+
+class ExistAPI
+  #example ExistAPI.new("http://localhost:8080/exist/xmlrpc", "admin", "password")    
+  def initialize(uri = nil , username = nil, password = nil)
+    @uri = uri
+    @username = username
+    @password = password
+    @parameters = { "encoding" => "UTF-8", "indent" => "yes"}
+    #outputoptions = { "encoding" => "UTF-8", "indent" => "yes"}
+    connect
+  end
+
+  private
+  def connect
+    @client = XMLRPC::Client.new2(@uri)
+    @client.user=(@username)
+    @client.password=(@password)
+    @client.call("isXACMLEnabled")  #test if the connection is established.
+  rescue XMLRPC::FaultException => e
+    raise e    
+  rescue
+    raise ExistException.new("Database login failed", 1), caller
+  end
+  
+  public
+  
+  def createcollection(_name, _parent = nil)
+    if (_parent == nil)
+      begin
+        result = @client.call("createCollection", _name)
+        return result
+      end
+    else
+      begin
+        colname = _parent.getname + _name
+        result = @client.call("createCollection", colname)
+        return result
+      end
+    end
+  rescue XMLRPC::FaultException => e
+    raise e    
+  rescue
+    raise ExistException.new("Failed to create Collection", 2), caller
+  end
+  
+  def getcollection(path)
+    if(path[-1] != "/")    #if last is not "/" then add it
+      path += "/"
+    end
+    col = Collection.new(@client, path)
+    return col
+  rescue  => e
+    raise e  
+  end
+  
+  def existscollection?(orig_path)
+    collections = orig_path.split("/")
+    collections.delete("")
+    i=0
+    path = "/" 
+    while(i < collections.length)
+      path = path + collections[i] + "/"
+      col = Collection.new(@client, path)
+      if (!col.childCollection.include?(collections[i+1]))
+        break
+      end
+      i = i + 1
+    end
+    
+    if(path[-1]=="/")
+      path = path[0..-2]
+    end
+    if(orig_path[-1]=="/")
+      orig_path = orig_path[0..-2]
+    end
+    
+    if(path == orig_path)
+      return true
+    else
+      return false
+    end
+  rescue  => e
+    raise e  
+  end
+
+  def remove_collection(_name)
+    # boolean removeCollection( String collection)
+    result = @client.call("removeCollection", _name)
+    return result
+  rescue XMLRPC::FaultException => e
+    raise e    
+  rescue
+    raise ExistException.new("Failed to remove Collection", 3), caller
+  end
+  
+  def storeresource(_res, _docname, _overwrite = 1)
+    if ((_res == nil)||(_docname == nil))
+      raise ExistException.new("Resource or document name is nil", 4), caller
+    end
+    begin
+      @client.call("parse",_res.to_s, _docname, _overwrite)
+    rescue XMLRPC::FaultException => e
+      raise e    
+    rescue ExistException => e
+      raise e
+    rescue
+      raise ExistException.new("Failed to store resource", 5), caller
+    end
+  end
+  
+  def execute_query(xquery, parameters = @parameters)
+    #puts xquery
+    begin
+      handle = @client.call("executeQuery", XMLRPC::Base64.new(xquery), parameters)
+      return handle
+    rescue XMLRPC::FaultException => e
+      raise e    
+    rescue
+      raise ExistException.new("Failed to execute query", 6), caller
+    end
+  end
+  
+  def retrieve(handle, pos)
+    begin
+      res = @client.call("retrieve", handle, pos, @parameters)
+      return res
+    rescue XMLRPC::FaultException => e
+      raise e   
+    rescue
+      raise ExistException.new("Failed to retrive resource", 7), caller
+    end
+  end
+  
+  def get_hits(handle)
+    begin
+      summary = @client.call("querySummary", handle)
+      hits = summary['hits']
+      return hits
+    rescue XMLRPC::FaultException => e
+      raise e
+    rescue
+      raise ExistException.new("Failed to get number of hits", 8), caller
+    end
+  end
+  
+  #<email type="office">andrew@gmail.com</email>, pos = into | following | preceding, expr_single e.g. //address[fname="Andrew"]
+  def update_insert(expr, pos, expr_single) 
+    query = "update insert "+expr+" "+pos+" "+expr_single
+    #puts "query #{query}"
+    execute_query(query)
+  rescue  => e
+    raise e    
+  end
+  
+  def update_replace(expr, expr_single)
+    query = "update replace "+expr+" with "+expr_single
+    execute_query(query)
+  rescue  => e
+    raise e  
+  end
+  
+  def update_value(expr, expr_single)
+    query = "update replace " + expr + " with " + expr_single
+    execute_query(query)
+  rescue  => e
+    raise e  
+  end
+  
+  def update_delete(expr)
+    query = "update delete " + expr
+    #puts "query #{query}"
+    execute_query(query)
+  rescue  => e
+    raise e  
+  end
+  
+  def update_rename(expr, expr_single)
+    query = "update rename " + expr + " as " + expr_single
+    #puts "query #{query}"
+    execute_query(query)
+  rescue  => e
+    raise e  
+  end
+end
+
+
+#db = ExistAPI.new("http://localhost:8080/exist/xmlrpc", "admin", "admin")
+#puts db.existscollection?("db")
+
+#client = XMLRPC::Client.new("localhost", "/exist/xmlrpc", 8080)
+
+#-----------------
+#if $*.length < 1 then
+#  puts "usage: collections.rb collection-path"
+#  exit(0)
+#end
+#
+#path = $*[0]
+#collection = Collection.new(client, "/db/pokus/")
+#puts collection.to_s
+#collection.documents { |d| puts d.to_s }
+#
+#doc = collection['books.xml']
+#if doc == nil 
+#  error("document not found")
+#end
+#puts doc.content

data/lib/exist_exception.rb

@@ -0,0 +1,52 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+class ExistException < RuntimeError
+
+  @description
+  @number
+
+  def initialize(_description = "Epic fail \n", _number = nil)
+    @description = _description + "\n"
+    @number  = _number
+  end
+
+  def inspect
+    self.tostring
+  end
+
+  def to_s
+    self.tostring
+  end
+
+  def tostring
+    @number.to_s + ": " +@description
+  end
+
+  def code
+    @number
+  end
+
+end
+
+#Soupis jednotlivych vyjimek, v zavorce metoda tera tuto vyjimku vyhazuje
+#1: Database login failed (DatabaseManager.connect)
+#2: Failed to create Collection (DatabaseManager.createcollection)
+#3: Failed to remove Collection (DatabaseManager.removecollection)
+#
+#10: Failed to initialize Collection (Collection.initialize)
+#11: Failed to close Collection (Collection.close)
+#12: No such child Collection (Collection.getchildcollection)
+#13: Failed to get parent Collection (Collection.getparentcollection)
+#14: Unknown resource (Collection.getresource)
+#15: Failed to list child Collections (Collection.listchildcollection)
+#16: Failed to list resources (Collection.listresources)
+#17: Failed to remove resource (Collection.removeresource)
+#18: Failed to store resource (Collection.storeresource)
+#
+#20: Failed to execute query (XPathQueryService.query)
+#21: Failed to query Resource (XPathQueryService.queryresource)
+#
+#30: Failed to update Collection (XUpdateService.update)
+#31: Failed to update Resource (XUpdateService.updateResource)
+#

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: eXistAPI
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jenda Sirl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-02 00:00:00.000000000 Z
+dependencies: []
+description: ! "API for eXist-db based on XML-RPC. \nAPI is using xQuery, xPath and
+  xQuery Update Facility."
+email: jan.sirl@seznam.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eXistAPI.rb
+- lib/collection.rb
+- lib/document.rb
+- lib/exist_exception.rb
+homepage: http://rubygems.org/gems/existapi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: API for eXist-db based on XML-RPC.
+test_files: []