simple_dav 0.0.5 → 0.0.6

data/README

@@ -0,0 +1,51 @@
+This class acts as a Ruby dav client. First Goal is to sync sogo with RoR apps
+
+First release allow to connect to sogo address book
+
+INSTALL :
+
+> gem install simple_dav
+
+USE :
+
+Example:
+
+  include SimpleDav
+
+  server = "mysogoserver.net"
+  ab = "personal" 
+  user = "user" 
+  pass = "secret"
+
+  adb = AddressBook.new(ab, :server => server,:verify => false, :ssl => true, :user => user, :pass => pass, :type => "sogo")
+
+  cards = Card.where(:email => "od@idfuze.com")
+  card = cards.first
+  card.to_s
+  > PRODID:-//IDFuze//SimpleDav//EN
+  > VERSION:3.0
+  > CLASS:PUBLIC
+  > PROFILE:VCARD
+  > N:titi
+  > EMAIL:od@idfuze.com
+  > UID:38294-1348845607-45923.vcf
+  > END:VCARD
+  card.update(:n => "Olivier", :fn => "dev")
+  > PRODID:-//IDFuze//SimpleDav//EN
+  > VERSION:3.0
+  > CLASS:PUBLIC
+  > PROFILE:VCARD
+  > N:Olivier
+  > EMAIL:od@idfuze.com
+  > UID:38294-1348845607-45923.vcf
+  > FN:dev
+  > END:VCARD
+  card.uid
+  > "UID:38294-1348845607-45923.vcf"
+  card.delete
+
+
+Many thanks to SOGo team you make a wonderfull work and i really want to add a little brick with that !
+
+
+Copyright (c) 2012 IDFUZE.COM / Olivier DIRRENBERGER

data/TODO

@@ -0,0 +1,7 @@
+Add look up for other calendar than personnal
+Add events support
+Add tasks support
+Add files support
+Support for locking
+Support for access control
+Support for vcard group managment

data/lib/simple_dav/address_book.rb

@@ -0,0 +1,164 @@
+module SimpleDav
+  class AddressBook < Base
+    attr_reader :group
+    def initialize(params)
+      abu = "personal"
+      @vcard = nil
+      super(params)
+      @abu = @type == "sogo" ? "Contacts/#{abu}/" : "#{abu}"
+      @uri.path += @abu
+      @group = nil #store group uid
+      Card.adb = self
+    end
+  
+    # select address book
+    def change_group(abu)
+      #todo select uid or nil if personnal
+      # old style folders
+      #@uri.path -= @abu
+      #@uri.path += (@abu = abu)
+      # new style v4 group
+      groups = Card.where({"X-ADDRESSBOOKSERVER-KIND" => "group", "f" => abu})
+      @group = groups && groups.first && groups.first.uid
+    end
+  
+    # list available address books
+    #find all X-ADDRESSBOOKSERVER-KIND
+    def list(name)
+      #Card.where("X-ADDRESSBOOKSERVER-KIND" => "group")
+      if name
+        query = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+          #xml.send('B:addressbook-query', 'xmlns:B' => "urn:ietf:params:xml:ns:carddav") do
+            xml.send('D:principal-property-search', 'xmlns:D' => "DAV:") do
+              xml.send('D:property-search') do
+                xml.send('D:prop') do
+                  xml.send('D:displayname')
+                end
+                xml.send('D:match') do
+                  xml << name
+                end
+              end
+              xml.send('D:prop') do
+                xml.send('C:addressbook-home-set', 'xmlns:C' => 'urn:ietf:params:xml:ns:carddav')
+                xml.send('D:displayname')
+              end
+          
+            end
+          
+          #end
+
+        end
+      else
+        query = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+          xml.send('A:propfind', 'xmlns:A' => 'DAV:') do
+            xml.send('A:prop') do
+              xml.send('D:addressbook-home-set', 'xmlns:D' => "urn:ietf:params:xml:ns:carddav")
+              xml.send('D:directory-gateway', 'xmlns:D' => "urn:ietf:params:xml:ns:carddav")
+              xml.send('A:displayname')
+              xml.send('C:email-address-set', 'xmlns:C' => "http://calendarserver.org/ns/")
+              xml.send('A:principal-collection-set')
+              xml.send('A:principal-URL')
+              xml.send('A:resource-id')
+              xml.send('A:supported-report-set')
+            end
+          end
+        end
+      end
+    
+      headers = {
+        "content-Type" => "text/xml; charset=\"utf-8\"",
+        "depth" => 0,
+        "brief" => "t",
+        "Content-Length" => "#{query.to_xml.to_s.size}"
+        }
+      content = @client.request('REPORT', @uri, nil, query.to_xml.to_s, headers)
+      puts content.body + "<<<<<\n\n"
+      xml = Nokogiri::XML(content.body)
+      vcards = []
+      xml.xpath('//C:address-data').each do |card|
+        vcards << Card.new(card.text)
+      end
+      return vcards
+    end
+  
+    # find addresse resource by uid
+    def self.find(uid)
+      Card.find(self, uid)
+    end
+  
+    # create collection : not working actually
+    def create_folder(name, displayname = "", description = "")
+      query = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+        xml.send('D:mkcol', 'xmlns:D' => "DAV:", 'xmlns:C' => "urn:ietf:params:xml:ns:carddav") do
+          xml.send('D:set') do
+            xml.send('D:prop')
+            xml.send('D:resourcetype') do
+              xml.send('D:collection')
+              xml.send('C:addressbook')
+            end
+          end
+          xml.send('D:displayname') do
+            xml << displayname
+          end
+          xml.send('C:addressbook-description', 'xml:lang' => "en") do
+            xml << description
+          end
+        end
+      end
+    
+      headers = {
+        "content-Type" => "text/xml; charset=\"utf-8\"",
+        "Content-Length" => query.to_xml.to_s.size
+        }
+
+      res = @client.request('MKCOL', @uri, nil, query.to_xml.to_s, headers)
+
+      if res.status < 200 or res.status >= 300
+        raise "create failed: #{res.inspect}"
+      else
+        true
+      end
+    end
+  
+    # create address book group
+    def create(name, description = "")
+      uid = "#{gen_uid}"
+    
+      @vcard = Card.new(GROUPVCF)
+      @vcard.add_attribute("X-ADDRESSBOOKSERVER-KIND", "group")
+      @vcard.add_attribute("rev", Time.now.utc.iso8601(2))
+      @vcard.add_attribute("uid", uid)
+      @vcard.add_attribute(:f, name)
+      @vcard.add_attribute(:fn, description)
+    
+      headers = {
+        "If-None-Match" => "*",
+        "Content-Type" => "text/vcard",
+        "Content-Length" => @vcard.to_s.size
+        }
+    
+      unc = @uri.clone
+      unc.path += "#{uid}.vcf"
+      res = @client.request('PUT', unc, nil, @vcard.to_s, headers)
+
+      if res.status < 200 or res.status >= 300
+        @uid = nil
+        raise "create failed: #{res.inspect}"
+      else
+        @uid = @group = uid
+      end
+      @vcard
+    
+    end
+  
+    # access to current vcard object
+    def vcard
+      @vcard
+    end
+
+    def debug_dev=(dev)
+      @client.debug_dev = dev
+    end
+
+  end
+end

data/lib/simple_dav/base.rb

@@ -0,0 +1,45 @@
+BASEVCF = <<EOF
+BEGIN:VCARD
+PRODID:-//IDFuze//SimpleDav//EN
+VERSION:3.0
+CLASS:PUBLIC
+PROFILE:VCARD
+END:VCARD
+EOF
+
+GROUPVCF = BASEVCF
+
+module SimpleDav
+  class Base
+    attr_reader :headers, :uri, :client
+  
+    # generate unique id to create resources
+    def gen_uid
+      "#{rand(100000)}-#{Time.now.to_i}-#{rand(100000)}"
+    end
+
+    def initialize(params = {})
+      begin
+        url = params[:ssl] ? "https://#{params[:server]}/" : "http://#{params[:server]}/"
+        url += case (@type = params[:type])
+        when "sogo" then "SOGo/dav/#{params[:user]}/"
+        else ""
+        end
+        @uri = URI.parse(url)
+        @uid = nil
+        @headers = {}
+        #open(uri) if uri
+        proxy = ENV['HTTP_PROXY'] || ENV['http_proxy'] || nil
+        @client = HTTPClient.new(proxy)
+        @client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE unless params[:verify]
+        if (@user = params[:user]) && params[:pass]
+          @client.set_basic_auth(@uri, @user, params[:pass])
+        end
+      rescue
+        raise RuntimeError.exception("Init Failed!! (#{$!.to_s})")
+      end
+    end
+
+  end
+
+end

data/lib/simple_dav/card.rb

@@ -0,0 +1,205 @@
+# attributes : n|email|title|nickname|tel|bday|fn|org|note|uid
+# todo change for another vcard managment class
+module SimpleDav
+  class Card
+    class << self; attr_accessor :adb end
+    @adb = nil
+
+    def initialize(text = BASEVCF)
+      @plain = text
+      return self
+    end
+
+    def self.find(uid)
+      where(:uid => uid)
+    end
+
+    # create address resource
+    def self.create(params)
+      @vcard = Card.new
+      params.each do |k,v|
+        @vcard.update_attribute(k,v)
+      end
+  
+      headers = {
+        "If-None-Match" => "*",
+        "Content-Type" => "text/vcard",
+        "Content-Length" => @vcard.to_s.size
+        }
+      uid = "#{adb.gen_uid}.vcf"
+  
+      @vcard.update_attribute(:uid, uid)
+      if adb && adb.group
+        @vcard.add_attribute("X-ADDRESSBOOKSERVER-MEMBER", "urn:uuid:#{adb.group}")
+      end
+  
+      unc = adb.uri.clone
+      unc.path += uid
+      res = adb.client.request('PUT', unc, nil, @vcard.to_s, headers)
+
+      if res.status < 200 or res.status >= 300
+        @uid = nil
+        raise "create failed: #{res.inspect}"
+      else
+        @uid = uid
+      end
+      @vcard
+    end
+
+    def update(params)
+      params.each do |k,v|
+        update_attribute(k,v)
+      end
+  
+      headers = {
+        "Content-Type" => "text/vcard",
+        "Content-Length" => @plain.size
+        }
+      uid = self.uid
+  
+      unc = Card.adb.uri.clone
+      unc.path += uid
+      res = Card.adb.client.request('PUT', unc, nil, @plain, headers)
+
+      if res.status < 200 or res.status >= 300
+        @uid = nil
+        raise "create failed: #{res.inspect}"
+      else
+        @uid = uid
+      end
+      self
+    end
+
+    def delete
+      if @uid && Card.adb
+
+        headers = {
+          #"If-None-Match" => "*",
+          "Content-Type" => "text/xml; charset=\"utf-8\""
+          }
+        unc = adb.uri.clone
+        unc.path += @uid
+        res = adb.client.request('DELETE', unc, nil, nil, headers)
+
+        if res.status < 200 or res.status >= 300
+          @uid = nil
+          raise "delete failed: #{res.inspect}"
+        else
+          @uid = nil
+          true
+        end
+      else
+        raise "Failed : no connection or null id"
+      end
+    end
+
+    def retreive
+      path = "#{self.uid}.vcf"
+      unc = adb.uri.clone
+      unc.path += path
+      res = adb.client.request('GET', unc)
+
+      if res.status < 200 or res.status >= 300
+        @uid = nil
+        raise "delete failed: #{res.inspect}"
+      else
+        @plain = res.body
+        @uid = uid
+        true
+      end
+    end
+
+    def update_attribute(a, v)
+      @plain.match(/^#{a.to_s.upcase}:(.+)$/) ? @plain.gsub!(/^#{a.to_s.upcase}:(.+)$/, "#{a.to_s.upcase}:#{v}") : add_attribute(a, v)
+    end
+
+    def add_attribute(a, v)
+      @plain["END:VCARD"] = "#{a.to_s.upcase}:#{v}\nEND:VCARD"
+    end
+
+    def method_missing(meth, *args, &block)
+      case meth.to_s 
+        when /^((n|email|title|nickname|tel|bday|fn|org|note|uid|X-ADDRESSBOOKSERVER-KIND)=?)$/
+          run_on_field($1, *args, &block)
+        when /^find_by_(.+)$/
+          run_find_by_method($1, *args, &block)
+      else
+        super
+      end
+    end
+
+    def run_on_field(attrs, *args, &block)
+      field = attrs.upcase
+      field["EMAIL"] = "EMAIL;TYPE=work" if field.match("EMAIL")
+
+      if field =~ /=/
+        field = field[0..-2]
+        update_attribute(field, args)
+      else
+        if m = @plain.match(/#{field}:(.+)$/) 
+          m[1]
+        else
+          nil
+        end
+      end
+    end
+
+      # find where RoR style
+    def self.where(conditions)
+      limit = nil #1
+      query = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+        xml.send('B:addressbook-query', 'xmlns:B' => "urn:ietf:params:xml:ns:carddav") do
+          xml.send('A:prop', 'xmlns:A' => "DAV:") do
+            xml.send('A:getetag')
+            xml.send('B:address-data') 
+        
+          end
+          #xml.send('C:filter', 'test' => "anyof") do
+          xml.send('B:filter', 'test' => 'anyof') do
+            conditions.each do |k,v|
+              xml.send('B:prop-filter', 'test' => 'allof','name' => k.to_s) do
+                #xml.send('C:text-match', 'collation' => "i;unicode-casemap", 'match-type' => "contains") do
+                xml.send('B:text-match', 'collation' => "i;unicode-casemap", 'match-type' => "contains") do
+                  xml << v
+                end
+              end
+            end
+          end
+          if limit
+            xml.send('C:limit') do
+              xml.send('C:nresults') do
+                xml << "#{limit}"
+              end
+            end
+          end
+        
+        end
+
+      end
+      headers = {
+        "content-Type" => "text/xml; charset=\"utf-8\"",
+        "depth" => 1,
+        "Content-Length" => "#{query.to_xml.to_s.size}"
+        }
+      content = adb.client.request('REPORT', adb.uri, nil, query.to_xml.to_s, headers)
+      xml = Nokogiri::XML(content.body)
+      vcards = []
+      xml.xpath('//C:address-data').each do |card|
+        vcards << Card.new(card.text)
+      end
+      return vcards
+    end
+
+    def run_find_by_method(attrs, *args, &block)
+      attrs = attrs.split('_and_')
+      attrs_with_args = [attrs, args].transpose
+      conditions = Hash[attrs_with_args]
+      where(conditions)
+    end
+
+    def to_s
+      @plain.to_s
+    end
+
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Olivier DIRRENBERGER
@@ -54,7 +54,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/simple_dav/address_book.rb
+- lib/simple_dav/base.rb
+- lib/simple_dav/card.rb
 - lib/simple_dav.rb
+- README
+- TODO
 has_rdoc: true
 homepage: https://github.com/reivilo/simple_dav
 licenses: []