dav4rack_ext 0.0.2

data/specs/rfc/rfc5397_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'RFC 5397: WebDAV Current Principal Extension' do
+  before do
+    @dav_ns = "DAV:"
+    
+    @user = user = stub('User', username: 'john')
+    
+    @root_path = root_path = '/'
+    
+    app = Rack::Builder.new do
+      # use XMLSniffer
+      run DAV4Rack::Carddav.app(root_path, current_user: user)
+    end
+    
+    serve_app(app)
+  end
+  
+  describe '[3] DAV:current-user-principal' do
+    should 'return current user principal' do
+      response = propfind(@root_path, [
+          ['current-user-principal', @dav_ns]
+        ])
+      
+      ensure_element_exists(response, %{D|prop > D|current-user-principal > D|href[text()="#{@root_path}"]})
+    end
+    
+    should 'return unauthenticated if not logged in' do
+      # response = propfind(@root_path, [
+      #     ['current-user-principal', @dav_ns]
+      #   ])
+      
+      # ensure_element_exists(response, %{D|prop > D|current-user-principal > D|unauthenticated})
+    end
+    
+  end
+  
+end

data/specs/rfc/rfc6352_spec.rb

@@ -0,0 +1,284 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe 'RFC 6352: CardDav' do
+  
+  before do
+    @dav_ns = "DAV:"
+    @carddav_ns = "urn:ietf:params:xml:ns:carddav"
+    
+    user_builder = proc do |env|
+      contact = FactoryGirl.build(:contact, uid: '1234-5678-9000-1')
+      contact.stubs(:etag).returns('ETAG')
+      contact.stubs(:vcard).returns(@parsed_vcard)
+      
+      FactoryGirl.build(:user, env: env, login: 'john', addressbooks: [
+          FactoryGirl.build(:book, path: 'castor', name: "A book", contacts: [contact])
+        ])
+    end
+    
+    app = Rack::Builder.new do
+      # use XMLSniffer
+      run DAV4Rack::Carddav.app('/', current_user: user_builder)
+    end
+    
+    serve_app(app)
+    
+    @vcard_raw = <<-EOS
+BEGIN:VCARD
+VERSION:3.0
+FN:Cyrus Daboo
+N:Daboo;Cyrus
+ADR;TYPE=POSTAL:;2822 Email HQ;Suite 2821;RFCVille;PA;15213;USA
+EMAIL;TYPE=INTERNET,PREF:cyrus@example.com
+NICKNAME:me
+NOTE:Example VCard.
+ORG:Self Employed
+TEL;TYPE=WORK,VOICE:412 605 0499
+TEL;TYPE=FAX:412 605 0705
+URL:http://www.example.com
+UID:1234-5678-9000-1
+END:VCARD
+    EOS
+    
+    
+    @vcard_raw2 = <<-EOS
+BEGIN:VCARD
+VERSION:3.0
+FN:John Doe
+N:John;Doe
+ADR;TYPE=POSTAL:;2822 Email HQ;Suite 2821;RFCVille;PA;15213;USA
+EMAIL;TYPE=INTERNET,PREF:cyrus@example.com
+NOTE:Example VCard.
+ORG:Self Employed
+TEL;TYPE=WORK,VOICE:412 605 0499
+TEL;TYPE=FAX:412 605 0705
+URL:http://www.example.com
+UID:1234-5678-9000-9
+END:VCARD
+    EOS
+    
+    @parsed_vcard = VCardParser::VCard.parse(@vcard_raw).first
+  end
+  
+      
+  describe '[6] Address Book Feature' do
+    
+    describe '[6.1] Address Book Support' do
+      it '[6.1] advertise carddav support (MUST include addressbook in DAV header)' do
+        response = request(:options, '/')
+        response.headers['Dav'].should.include?('addressbook')
+        response.status.should == 200
+      end
+    end
+    
+    describe '[6.2] AddressBook properties' do
+    
+      it '[6.2.1] CARDDAV:addressbook-description' do
+      #   request('/', method: 'OPTIONS')
+      end
+      
+      it '[6.2.3] CARDDAV:max-resource-size' do
+        
+      end
+      
+    end
+    
+    
+    
+    describe '[6.3] Creating Resources' do
+      
+      it '[6.3.1] Extended MKCOL Method' do
+        # optional
+      end
+      
+      describe '[6.3.2] Creating Address Object Resources' do
+        before do
+          @headers = {
+            'HTTP_IF_NONE_MATCH' => '*'
+          }
+        end
+        
+        should 'create contact' do
+          Testing::Contact.any_instance.expects(:etag).returns("ETAG")
+          
+          # the url does not need to match the UID
+          response = request(:put, '/books/castor/new.vcf', @headers.merge(input: @vcard_raw2))
+          response.status.should == 201
+          
+          # 6.3.2.3
+          response.headers['ETag'].should == "ETAG"
+        end
+        
+        should 'return an error if contact exists' do
+          response = request(:put, '/books/castor/new.vcf', @headers.merge(input: @vcard_raw))
+          response.status.should == 409 # Conflict
+        end
+        
+        
+        describe '[6.3.2.1] Additional Preconditions for PUT, COPY, and MOVE' do
+          should 'enforce CARDDAV:supported-address-data' do
+            
+          end
+          
+          should 'enforce CARDDAV:valid-address-data' do
+            
+          end
+          
+          should 'enforce CARDDAV:no-uid-conflict' do
+            
+          end
+          
+          should 'enforce CARDDAV:max-resource-size' do
+            
+          end
+        end
+        
+        
+        describe '[6.3.2.3] Address Object Resource Entity Tag' do
+          should 'set Etag header on GET' do
+            response = request(:get, '/books/castor/1234-5678-9000-1.vcf')
+            response.status.should == 200
+            response.headers['ETag'].should == "ETAG"
+          end
+          
+        end
+        
+      end
+    end
+  
+  end
+  
+  
+  
+  
+  
+  
+  describe '[7] Address Book Access Control' do
+    
+    it '[7.1.1] CARDDAV:addressbook-home-set Property' do
+      response = propfind('/', [
+          ['addressbook-home-set', @carddav_ns]
+        ])
+            
+      response.status.should == 207
+      
+      value = element_content(response, 'D|addressbook-home-set', 'D' => @carddav_ns)
+      value.should == '/books/'
+      
+      # should not be returned by all
+      response = propfind('/')
+      value = element_content(response, 'D|addressbook-home-set', 'D' => @carddav_ns)
+      value.should == :missing
+    end
+    
+    it '[7.1.2] CARDDAV:principal-address Property' do
+      response = propfind('/', [
+          ['principal-address', @carddav_ns]
+        ])
+            
+      response.status.should == 207
+      
+      value = element_content(response, 'D|principal-address', 'D' => @carddav_ns)
+      value.should == :empty
+    end
+    
+  end
+  
+  
+  
+  
+  describe '[8] Address Book Reports' do
+    should 'advertise supported reports (REPORT method)' do
+      response = propfind('/books/', [
+          ['supported-report-set', @dav_ns]
+        ])
+      
+      elements = ensure_element_exists(response, 'D|supported-report-set > D|report > C|addressbook-multiget',
+          'D' => @dav_ns, 'C' => @carddav_ns
+        )
+      elements[0].text.should == ""
+    end
+    
+    
+    describe '[8.3.1] CARDDAV:supported-collation-set Property' do
+      should 'return supported collations' do
+        response = propfind('/books/castor', [
+            ['supported-collation-set', @carddav_ns]
+          ])
+        
+        elements = ensure_element_exists(response, 'D|supported-collation-set', 'D' => @carddav_ns)
+        elements[0].text.should == ""
+      end
+        
+      should 'not be returned in allprop query' do
+        # should not be returned by all
+        response = propfind('/books/castor')
+        
+        ensure_element_does_not_exists(response, 'D|supported-collation-set', 'D' => @carddav_ns)
+      end
+    end
+    
+    it '[8.6] CARDDAV:addressbook-query Report' do
+      # unsupported for now
+    end
+    
+    
+    describe '[8.7] CARDDAV:addressbook-multiget Report' do
+      before do
+        @contact = FactoryGirl.build(:contact, uid: '1234-5678-9000-1')
+        @contact.stubs(:vcard).returns(@parsed_vcard)
+
+        
+        @raw_query = <<-EOS
+ <?xml version="1.0" encoding="utf-8" ?>
+ <C:addressbook-multiget xmlns:D="DAV:" xmlns:C="urn:ietf:params:xml:ns:carddav">
+   <D:prop>
+     <D:getetag/>
+     <C:address-data>
+       <C:prop name="VERSION"/>
+       <C:prop name="UID"/>
+       <C:prop name="NICKNAME"/>
+       <C:prop name="EMAIL"/>
+       <C:prop name="FN"/>
+     </C:address-data>
+   </D:prop>
+   <D:href>/books/castor/1234-5678-9000-1.vcf</D:href>
+   <D:href>/books/castor/1234-5678-9000-2.vcf</D:href>
+ </C:addressbook-multiget>
+        EOS
+      end
+      
+      should 'return multiple cards' do
+        response = request(:report, "/books/castor", input: @raw_query, 'HTTP_DEPTH' => '0')
+        response.status.should == 207
+        
+        # '*=' = include
+        ensure_element_exists(response, %{D|href[text()*="1234-5678-9000-2"] + D|status[text()*="404"]}, 'D' => @dav_ns)
+        
+        
+        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
+BEGIN:VCARD
+VERSION:3.0
+FN:Cyrus Daboo
+EMAIL;TYPE=INTERNET,PREF:cyrus@example.com
+NICKNAME:me
+UID:1234-5678-9000-1
+END:VCARD
+        EOS
+      end
+      
+      should 'return an error with Depth != 0' do
+        response = request(:report, "/books/castor", input: @raw_query, 'HTTP_DEPTH' => '2')
+        response.status.should == 400
+        
+        ensure_element_exists(response, 'D|error > D|invalid-depth', 'D' => @dav_ns)
+      end
+      
+    end
+    
+    
+  end
+  
+  
+end

data/specs/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'eetee'
+
+if ENV['COVERAGE']
+  
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter ".*_spec"
+    add_filter "/helpers/"
+  end
+  
+end
+
+$LOAD_PATH.unshift( File.expand_path('../../lib' , __FILE__) )
+require 'dav4rack_ext'
+require 'factory_girl'
+
+
+require 'eetee/ext/mocha'
+require 'eetee/ext/rack'
+
+
+require_relative '../example/rack_sniffer'
+require_relative 'support/models'
+require_relative 'factories'
+
+Thread.abort_on_exception = true
+
+
+module Rack::Test
+  class Session
+    def propfind(uri, params = {}, env = {}, &block)
+      env = env_for(uri, env.merge(:method => "PROPFIND", :params => params))
+      process_request(uri, env, &block)
+    end
+  end
+end
+
+
+

data/specs/support/models.rb

@@ -0,0 +1,161 @@
+require 'virtus'
+
+
+module Testing
+  
+  class DummyBase
+    include Virtus
+    
+    attribute :updated_at, Time, default: Time.now
+    attribute :created_at, Time, default: Time.now
+    
+  end
+
+
+  class Field < DummyBase
+    
+    attribute :group, String
+    attribute :name, String
+    attribute :value, String
+    attribute :params, Hash, default: {}
+    
+    
+    def self.from_vcf_field(f)
+      new(group: f.group, name: f.name, value: f.value, params: f.params)
+    end
+  end
+
+  class Contact < DummyBase
+    
+    attribute :uid, String
+    attribute :fields, Array[Field], default: []
+    
+    alias :path :uid
+    
+    def update_from_vcard(vcf)
+      raise "invalid uid" unless vcf['UID'].value == uid
+      self.updated_at = Time.now
+      
+      # TODO: addressbook rename fields
+      
+      vcf.each_field do |a|
+        existing_field = fields.detect do |f|
+          (f.name == a.name) && (f.group == a.group) && (f.params == a.params)
+        end
+        
+        if existing_field
+          puts "Updated '#{a.group}.#{a.name}' to '#{a.value}'"
+          existing_field.value = a.value
+        else
+          puts "Created '#{a.group}.#{a.name}' with '#{a.value}'"
+          fields << Field.from_vcf_field(a)
+        end
+      end
+      
+    end
+    
+    def save
+      p fields
+      
+      # no-op
+      true
+    end
+    
+    def destroy
+      true
+    end
+    
+    def etag
+      rand(1000).to_s
+    end
+    
+    def vcard
+      vcard = VCardParser::VCard.new("3.0")
+      vcard.add_field('UID', uid)
+      
+      fields.each do |f|
+        puts "[vCard] Adding field #{f.name} / #{f.value} / #{f.group} / #{f.params}"
+        vcard.add_field(f.name, f.value, f.group, f.params)
+      end
+      
+      vcard
+    end
+    
+  end
+
+
+
+  class AddressBook < DummyBase
+    
+    attribute :name, String
+    attribute :path, String
+    attribute :contacts, Array[Contact], default: []
+    
+    def find_contact(uid)
+      contacts.detect{|c| c.uid == uid.to_s }
+    end
+    
+    def create_contact(uid)
+      Contact.new(uid: uid).tap do |c|
+        contacts << c
+      end
+    end
+    
+    def updated_at
+      Time.now.to_i
+    end
+    
+  end
+
+
+  class User < DummyBase
+    
+    attribute :login, String
+    attribute :addressbooks, Array[AddressBook], default: []
+    
+    def initialize(env, *args)
+      super(*args)
+      @env = env
+    end
+    
+    def all_addressbooks
+      # may filter with router_params, or not
+      addressbooks
+    end
+    
+    
+    def find_addressbook(params)
+      path = params[:book_id]
+      addressbooks.detect{|b| b.path == path }
+    end
+    
+    
+    def current_addressbook
+      path = router_params[:book_id]
+      addressbooks.detect{|b| b.path == path }
+    end
+    
+    def current_contact
+      uid = router_params[:contact_id]
+      if uid && current_addressbook
+        current_addressbook.find_contact(uid)
+      else
+        nil
+      end
+    end
+    
+    def contacts
+      current_addressbook.contacts
+    end
+  
+  private
+    def router_params
+      @env['router.params'] || {}
+    end
+    
+    
+  end
+  
+end
+
+