dav4rack_ext 0.0.5 → 0.0.6

data/README.md

@@ -13,6 +13,19 @@ This gem extends dav4rack to provide a CardDAV extension, CalDAV is not currentl
 
 Have a look at the examle folder, this is a standard Rack application and should run with any compliant server.
 
+You can run the example with thin like this:
+
+```bash
+$ cd example
+$ bundle exec thin start
+```
+
+Once the server is started you can connect to it using http://127.0.0.1:3000/u/cards with any login/password
+(the example has no authentication set up)
+
+# Supported clients
+- Mac OS X (tested with Mountain Lion )
+- iPhone 5.x and 6.x
 
 # Setting up development environment
 

data/lib/dav4rack_ext/carddav/app.rb

@@ -6,8 +6,8 @@ module DAV4Rack
     DAV_EXTENSIONS = ["access-control", "addressbook"].freeze
     
     def self.app(root_path = '/', opts = {})
-      logger = opts.delete(:logger) || ::Logger.new('/dev/null')
-      current_user = opts.delete(:current_user)
+      logger        = opts.delete(:logger) || ::Logger.new('/dev/null')
+      current_user  = opts.delete(:current_user)
       root_uri_path = opts.delete(:root_uri_path) || root_path
       
       if (root_path != '/') && root_path[-1] == '/'

data/lib/dav4rack_ext/carddav/controller.rb

@@ -2,6 +2,13 @@ module DAV4Rack
   module Carddav
     
     class Controller < DAV4Rack::Controller
+      include DAV4Rack::Utils
+
+      NAMESPACES = {
+        'D' => 'DAV:',
+        'C' => 'urn:ietf:params:xml:ns:carddav'
+      }
+
       def initialize(*args, options, env)
         super(*args, options.merge(env: env))
       end
@@ -46,67 +53,45 @@ module DAV4Rack
         end
         "*[local-name()='#{name}' and namespace-uri()='#{ns_uri}']"
       end
-      
-        include DAV4Rack::Utils
-        
-        def xpath_element(name, ns_uri=:dav)
-          case ns_uri
-          when :dav
-            ns_uri = 'DAV:'
-          when :carddav
-            ns_uri = 'urn:ietf:params:xml:ns:carddav'
+
+      def addressbook_multiget(request_document)
+        # TODO: Include a DAV:error response
+        # CardDAV §8.7 clearly states Depth must equal zero for this report
+        # But Apple's AddressBook.app sets the depth to infinity anyhow.
+        unless depth == 0 or depth == :infinity
+          render_xml(:error) do |xml|
+            xml.send :'invalid-depth'
           end
-          "*[local-name()='#{name}' and namespace-uri()='#{ns_uri}']"
+          raise BadRequest
         end
-        
-        def addressbook_multiget(request_document)
-          # TODO: Include a DAV:error response
-          # CardDAV §8.7 clearly states Depth must equal zero for this report
-          # But Apple's AddressBook.app sets the depth to infinity anyhow.
-          unless depth == 0 or depth == :infinity
-            render_xml(:error) do |xml|
-              xml.send :'invalid-depth'
-            end
-            raise BadRequest
-          end
 
-          props = request_document.xpath("/#{xpath_element('addressbook-multiget', :carddav)}/#{xpath_element('prop')}").children.find_all(&:element?).map{|n|
-            to_element_hash(n)
-          }
-          # Handle the address-data element
-          # - Check for child properties (vCard fields)
-          # - Check for mime-type and version.  If present they must match vCard 3.0 for now since we don't support anything else.
-          hrefs = request_document.xpath("/#{xpath_element('addressbook-multiget', :carddav)}/#{xpath_element('href')}").collect{|n| 
-            text = n.text
-            # TODO: Make sure that the hrefs passed into the report are either paths or fully qualified URLs with the right host+protocol+port prefix
-            path = URI.parse(text).path
-            Logger.debug "Scanned this HREF: #{text} PATH: #{path}"
-            text
-          }.compact
-          
-          if hrefs.empty?
-            xml_error(BadRequest) do |err|
-              err.send :'href-missing'
-            end
+        # props = request_document.css("C|addressbook-multiget C|address-data > C|prop", namespaces).map do |el|
+        props = []
+        request_document.css("C|addressbook-multiget > D|prop", NAMESPACES).each do |el|
+          el.children.select(&:element?).each do |child|
+            props << to_element_hash(child)
           end
+        end
+
+        # collect the requested urls
+        hrefs = request_document.css("C|addressbook-multiget D|href", NAMESPACES).map(&:content)
 
-          multistatus do |xml|
-            hrefs.each do |_href|
-              xml.response do
-                xml.href _href
+        multistatus do |xml|
+          hrefs.each do |_href|
+            xml.response do
+              xml.href _href
 
-                path = File.split(URI.parse(_href).path).last
-                Logger.debug "Creating child w/ ORIG=#{resource.public_path} HREF=#{_href} FILE=#{path}!"
-                
-                cur_resource = resource.is_self?(_href) ? resource : resource.find_child(File.split(path).last)
+              path = File.split(URI.parse(_href).path).last
+              Logger.debug "Creating child w/ ORIG=#{resource.public_path} HREF=#{_href} FILE=#{path}!"
 
-                if cur_resource && cur_resource.exist?
-                  propstats(xml, get_properties(cur_resource, props))
-                else
-                  xml.status "#{http_version} #{NotFound.status_line}"
-                end
+              cur_resource = resource.is_self?(_href) ? resource : resource.find_child(File.split(path).last)
 
+              if cur_resource && cur_resource.exist?
+                propstats(xml, get_properties(cur_resource, props))
+              else
+                xml.status "#{http_version} #{NotFound.status_line}"
               end
+
             end
           end
         end

data/lib/dav4rack_ext/carddav/resource.rb

@@ -18,12 +18,7 @@ module DAV4Rack
       end
       
       def user_agent
-        env = options[:env]
-        if env
-          env['HTTP_USER_AGENT'] || ""
-        else
-          ""
-        end
+        options[:env]['HTTP_USER_AGENT'].to_s rescue ""
       end
             
       def router_params
@@ -31,10 +26,9 @@ module DAV4Rack
       end
       
       def setup
-                
         @propstat_relative_path = true
         @root_xml_attributes = {
-          'xmlns:C' => CARDAV_NS, 
+          'xmlns:C' => CARDAV_NS,
           'xmlns:APPLE1' => 'http://calendarserver.org/ns/'
         }
       end
@@ -51,9 +45,8 @@ module DAV4Rack
         namespace = element[:ns_href]
         
         key = "#{namespace}*#{name}"
-        
-        handler = self.class.properties[key]
-        if handler
+
+        if handler = self.class.properties[key]
           ret = instance_exec(element, &handler[0])
           # TODO: find better than that
           if ret.is_a?(String) && ret.include?('<')
@@ -93,7 +86,6 @@ module DAV4Rack
 
       def properties
         selected_properties = self.class.properties.reject{|key, arr| arr[1] == true }
-        ret = {}
         selected_properties.keys.map do |key|
           ns, name = key.split('*')
           {:name => name, :ns_href => ns}

data/lib/dav4rack_ext/carddav/resources/addressbook_collection_resource.rb

@@ -4,7 +4,7 @@ module DAV4Rack
     class AddressbookCollectionResource < Resource
       
       def exist?
-        return true
+        true
       end
 
       def collection?

data/lib/dav4rack_ext/carddav/resources/contact_resource.rb

@@ -42,8 +42,6 @@ module DAV4Rack
           end
         end
       end
-      
-      
 
       def collection?
         false
@@ -56,10 +54,8 @@ module DAV4Rack
       
       def setup
         super
-        
         @address_book = @options[:_parent_] || current_user.current_addressbook()
         @contact = @options[:_object_] || current_user.current_contact()
-        
       end
 
       def put(request, response)
@@ -84,9 +80,8 @@ module DAV4Rack
 
         # If the client has explicitly stated they want a new contact
         raise Conflict if (want_new_contact and @contact)
-        
-        if_match = request.env['HTTP_IF_MATCH']
-        if if_match
+
+        if if_match = request.env['HTTP_IF_MATCH']
           # client wants to update a contact, return an error if no
           # contact was found
           if (if_match == '*') || !@contact
@@ -109,18 +104,15 @@ module DAV4Rack
 
         @contact.update_from_vcard(vcf)
 
-        if @contact.save
+        if @contact.save(user_agent)
           new_public = @public_path.split('/')[0...-1]
           new_public << @contact.uid.to_s
-          
+
           @public_path = new_public.join('/')
           response['ETag'] = @contact.etag
-          Created
-        else
-          # Mac OS X Contact will reload the contact
-          # from the server
-          raise Forbidden
         end
+        
+        Created
       end
 
       def parent

data/lib/dav4rack_ext/carddav/resources/principal_resource.rb

@@ -4,15 +4,13 @@ module DAV4Rack
     class PrincipalResource < Resource
       
       def exist?
-        ret = (path == '') || (path == '/')
-        return ret
+        (path == '') || (path == '/')
       end
 
       def collection?
-        return true
+        true
       end
-      
-      
+
       define_properties('DAV:') do
         property('alternate-URI-set') do
           # "<D:alternate-URI-set xmlns:D='DAV:' />"
@@ -66,7 +64,6 @@ module DAV4Rack
           EOS
         end
 
-        
         property('resourcetype') do
           <<-EOS
             <resourcetype>
@@ -104,7 +101,6 @@ module DAV4Rack
           property('principal-address') do
             ""
           end
-
         end
       end
     

data/lib/dav4rack_ext/handler.rb

@@ -1,51 +1,45 @@
 require 'dav4rack/http_status'
 
 module DAV4RackExt
-  
   class Handler
     # include DAV4Rack::HTTPStatus
-    
-    def initialize(options= {})
-      @options = options.dup
-      @logger = options.delete(:logger)
+
+    def initialize(options = {})
+      @options          = options.dup
+      @logger           = options.delete(:logger)
+      @controller_class = options.delete(:controller_class) || DAV4Rack::Controller
     end
 
     def call(env)
+      request  = Rack::Request.new(env)
+      response = Rack::Response.new
+
       begin
-        request = Rack::Request.new(env)
-        response = Rack::Response.new
-        
-        controller = nil
-        begin
-          
-          controller_class = @options[:controller_class] || DAV4Rack::Controller
-          controller = controller_class.new(request, response, @options.dup, env)
-          res = controller.send(request.request_method.downcase)
-          response.status = res.code if res.respond_to?(:code)
-          
-        rescue DAV4Rack::HTTPStatus::Status => status
-          response.status = status.code
-        end
-        
-        response['Content-Length'] = response.body.to_s.bytesize unless response['Content-Length'] || !response.body.is_a?(String)
-        response.body = [response.body] unless response.body.respond_to? :each
-        response.status = response.status ? response.status.to_i : 200
-        response.headers.keys.each do |k|
-          response.headers[k] = response[k].to_s
-        end
-        
-        while request.body.read(8192)
-          # Apache wants the body dealt with, so just read it and junk it
-        end
-        
-        response.finish
-      rescue Exception => e
-        @logger.error "DAV Error: #{e}\n#{e.backtrace.join("\n")}"
-        raise e
+        controller = @controller_class.new(request, response, @options.dup, env)
+        res = controller.send(request.request_method.downcase)
+        response.status = res.code if res.respond_to?(:code)
+
+      rescue DAV4Rack::HTTPStatus::Status => status
+        response.status = status.code
+      end
+
+      response['Content-Length'] = response.body.to_s.bytesize unless response['Content-Length'] || !response.body.is_a?(String)
+      response.body = [response.body] unless response.body.respond_to? :each
+      response.status = response.status ? response.status.to_i : 200
+      response.headers.keys.each do |k|
+        response.headers[k] = response[k].to_s
       end
+
+      while request.body.read(8192)
+        # Apache wants the body dealt with, so just read it and junk it
+      end
+
+      response.finish
+    rescue Exception => e
+      @logger.error "DAV Error: #{e}\n#{e.backtrace.join("\n")}"
+      raise e
     end
-    
-  end
 
+  end
 end
 

data/lib/dav4rack_ext/helpers/properties.rb

@@ -1,55 +1,55 @@
-    module Helpers
-      module Properties
-        class MethodMissingRedirector
-          def initialize(*methods, &block)
-            @block = block
-            @methods = methods
-          end
-          
-          def method_missing(name, *args, &block)
-            if @methods.empty? || @methods.include?(name)
-              @block.call(name, *args, &block)
-            end
-          end
-        end
-        
-        def self.extended(klass)
-          class << klass
-            include MetaClassMethods
-          end
-        end
-        
-        # inheritable accessor
-        module MetaClassMethods
-          def define_property(namespace, name, explicit = false, &block)
-            _properties["#{namespace}*#{name}"] = [block, explicit]
-          end
-          
-          def properties
-            inherited = superclass.respond_to?(:properties) ? superclass.properties : {}
-            inherited.merge(_properties)
-          end
-          
-          def _properties
-            @properties ||= {}
-          end
+module Helpers
+  module Properties
+    class MethodMissingRedirector
+      def initialize(*methods, &block)
+        @block = block
+        @methods = methods
+      end
+
+      def method_missing(name, *args, &block)
+        if @methods.empty? || @methods.include?(name)
+          @block.call(name, *args, &block)
         end
-        
-        def define_properties(namespace, &block)
-          explicit = false
-          obj = MethodMissingRedirector.new(:property, :explicit) do |method_name, name, &block|
-            if method_name == :property
-              define_property(namespace, name.to_s, explicit, &block)
-            elsif method_name == :explicit
-              explicit = true
-              block.call
-            else
-              raise NoMethodError, method_name
-            end
-          end
-          
-          obj.instance_eval(&block)
+      end
+    end
+
+    def self.extended(klass)
+      class << klass
+        include MetaClassMethods
+      end
+    end
+
+    # inheritable accessor
+    module MetaClassMethods
+      def define_property(namespace, name, explicit = false, &block)
+        _properties["#{namespace}*#{name}"] = [block, explicit]
+      end
+
+      def properties
+        inherited = superclass.respond_to?(:properties) ? superclass.properties : {}
+        inherited.merge(_properties)
+      end
+
+      def _properties
+        @properties ||= {}
+      end
+    end
+
+    def define_properties(namespace, &block)
+      explicit = false
+      obj = MethodMissingRedirector.new(:property, :explicit) do |method_name, name, &block|
+        if method_name == :property
+          define_property(namespace, name.to_s, explicit, &block)
+        elsif method_name == :explicit
+          explicit = true
+          block.call
+        else
+          raise NoMethodError, method_name
         end
-        
       end
+
+      obj.instance_eval(&block)
     end
+
+  end
+end

data/lib/dav4rack_ext/version.rb

@@ -1,3 +1,3 @@
 module Dav4rackExt
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/specs/rfc/rfc6352_spec.rb

@@ -255,6 +255,9 @@ END:VCARD
         # '*=' = include
         ensure_element_exists(response, %{D|href[text()*="1234-5678-9000-2"] + D|status[text()*="404"]}, 'D' => @dav_ns)
         
+        # <D:getetag>"23ba4d-ff11fb"</D:getetag>
+        etag = ensure_element_exists(response, %{D|href[text()*="1234-5678-9000-1"] + D|propstat > D|prop > D|getetag}, 'D' => @dav_ns)
+        etag.text.should == 'ETAG'
         
         vcard = ensure_element_exists(response, %{D|href[text()*="1234-5678-9000-1"] + D|propstat > D|prop > C|address-data}, 'D' => @dav_ns, 'C' => @carddav_ns)
         vcard.text.should.include? <<-EOS

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dav4rack_ext
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-09 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dav4rack
@@ -116,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2833907520245342566
+      hash: -2586617098076442739
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,10 +125,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2833907520245342566
+      hash: -2586617098076442739
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: CardDAV / CalDAV implementation.