agcaldav 0.2 → 0.2.1

data/README.md

@@ -0,0 +1,49 @@
+#Ruby CalDAV library named "agcaldav"
+**agcaldav is a CalDAV library based on martinpovolny/ruby-caldav and 4fthawaiian/ruby-caldav and collectiveidea/caldav**
+
+##Usage
+
+First, you've to install the gem
+
+    gem install agcaldav
+
+and require it
+
+    require "agcaldav"
+
+Next you have to obtain the URI, username and password to a CalDAV-Server. If you don't have one try RADICALE (https://github.com/agilastic/Radicale). It's small, simple and written in python. In the following steps I'm using the default params of Radical.
+
+
+Now you can e.g. create a new AgCalDAV-Client:
+    	
+	cal = AgCalDAV::Client.new(:uri => "http://localhost:5232/user/calendar", :user => "user" , :password => "")
+
+Alternatively, the proxy parameters can be specified:
+
+	cal = AgCalDAV::Client.new(:uri => "http://localhost:5232/user/calendar",:user => "user" , :password => "password, :proxy_uri => "http://my-proxy.com:8080")
+
+
+####Create an Event and save it
+
+    result = cal.create_event(:start => "2012-12-29 10:00", :end => "2012-12-30 12:00", :title => "12345", :description => "sdkvjsdf sdkf sdkfj sdkf dsfj")
+
+Determine Event UID:
+
+    result[:uid]
+
+
+Find Event:
+    
+    r = cal.find_event(result[:uid])
+
+
+Find Events within time interval:
+
+    result = cal.find_events(:start => "2012-10-01 08:00", :end => "2013-01-01")
+    #TODO.... (no XML -> Icalendar with multiple events....)
+
+
+
+... next tomorrow ...
+
+

data/agcaldav.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/caldav/version', __FILE__)
+require File.expand_path('../lib/agcaldav/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "agcaldav"
-  s.version     = CalDAV::VERSION
-  s.summary     = "new Ruby CalDAV client"
-  s.description = "yet another new Ruby client for CalDAV calendar and tasks."
+  s.version     = AgCalDAV::VERSION
+  s.summary     = "Ruby CalDAV client"
+  s.description = "yet another great Ruby client for CalDAV calendar and tasks."
 
   s.required_ruby_version     = '>= 1.9.2'
 
@@ -22,7 +22,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'uuid'
   s.add_runtime_dependency 'builder'
   #s.add_dependency "json"
-  #s.add_development_dependency "rspec"  
+  s.add_development_dependency "rspec"  
+  # sorry for no tests atm :-/
 
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]

data/lib/agcaldav/client.rb

@@ -0,0 +1,154 @@
+module AgCalDAV
+    class Client
+        include Icalendar
+        attr_accessor :host, :port, :url, :user, :password, :ssl
+
+        def format=( fmt )
+            @format = fmt
+        end
+
+        def format
+            @format ||= Format::Debug.new
+        end
+
+        def initialize( data )                                        
+            unless data[:proxy_uri].nil?
+              proxy_uri   = URI(data[:proxy_uri])
+              @proxy_host = proxy_uri.host 
+              @proxy_port = proxy_uri.port.to_i
+            end
+            uri = URI(data[:uri])
+            @host     = uri.host
+            @port     = uri.port.to_i
+            @url      = uri.path
+            @user     = data[:user]
+            @password = data[:password] 
+            @ssl      = uri.scheme == 'https'            
+        end
+    
+        def __create_http
+          if @proxy_uri.nil?
+            http = Net::HTTP.new(@host, @port)
+          else        
+            http = Net::HTTP.new(@host, @port, @proxy_host, @proxy_port)
+          end
+          if @ssl
+            http.use_ssl = @ssl
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+            http
+        end
+    
+        def find_events data
+            datetime_start = data[:start]
+            datetime_stop  = data[:end]
+            res = nil
+            __create_http.start {|http|
+                req = Net::HTTP::Report.new(@url, initheader = {'Content-Type'=>'application/xml'} )
+                req.basic_auth @user, @password
+                req.body = AgCalDAV::Request::ReportVEVENT.new(DateTime.parse(datetime_start).strftime("%Y%m%dT%H%M"), 
+                                                             DateTime.parse(datetime_stop).strftime("%Y%m%dT%H%M") ).to_xml
+                res = http.request( req )
+            }
+            format.parse_calendar( res.body ) #TODO
+            #result = Icalendar.parse(res.body)            
+        end
+        
+        def find_event uuid
+            res = nil
+            __create_http.start {|http|
+                req = Net::HTTP::Get.new("#{@url}/#{uuid}.ics")
+                req.basic_auth @user, @password
+                res = http.request( req )
+            }
+            #raise AuthenticationError if res.code.to_i == 401
+            #raise APIError if res.code.to_i >= 500
+            result = Icalendar.parse(res.body)
+            result
+        end
+    
+        def delete_event uuid
+          __create_http.start {|http|
+              req = Net::HTTP::Delete.new("#{@url}/#{uuid}.ics")
+              req.basic_auth @user, @password
+              res = http.request( req )
+            }
+        end
+    
+        def create_event event
+          c = Calendar.new
+          uuid = UUID.new.generate
+          c.event do
+            uid           uuid  # still a BUG
+            dtstart       DateTime.parse(event[:start])
+            dtend         DateTime.parse(event[:end])
+            duration      event[:duration]
+            summary       event[:title]
+            description   event[:description]
+            klass         event[:accessibility] #PUBLIC, PRIVATE, CONFIDENTIAL
+            location      event[:location]
+            geo_location  event[:geo_location]
+            status        event[:status]
+          end
+          c.publish
+          c.event.uid = uuid  
+          cstring = c.to_ical
+          res = nil
+          http = Net::HTTP.new(@host, @port) 
+          __create_http.start { |http|
+            req = Net::HTTP::Put.new("#{@url}/#{uuid}.ics")
+            req['Content-Type'] = 'text/calendar'
+            req.basic_auth @user, @password
+            req.body = cstring
+            res = http.request( req )
+          }
+          raise AuthenticationError if res.code.to_i == 401
+          raise APIError if res.code.to_i >= 500
+          {:uid => uuid, :cal => c, :cal_string => cstring, :response_code => res.code} #TODO
+        end
+    
+        def add_alarm tevent, altCal="Calendar"
+            # FIXME create icalendar event -> cal.event.new (tevent)  
+          
+            # TODO  
+
+
+
+
+        end
+        
+        def update event
+           # FIXME old one not neat 
+          
+            # TODO 
+        end
+    
+        def todo 
+            res = nil
+            __create_http.start {|http|
+                req = Net::HTTP::Report.new(@url, initheader = {'Content-Type'=>'application/xml'} )
+                req.basic_auth @user, @password
+                req.body = AgCalDAV::Request::ReportVTODO.new.to_xml
+                res = http.request( req )
+            }
+            # FIXME: process HTTP code
+            format.parse_todo( res.body )
+        end
+        
+        def filterTimezone( vcal )
+            data = ""
+            inTZ = false
+            vcal.split("\n").each{ |l| 
+                inTZ = true if l.index("BEGIN:VTIMEZONE") 
+                data << l+"\n" unless inTZ 
+                inTZ = false if l.index("END:VTIMEZONE") 
+            }
+            return data
+        end
+    end
+
+  class AgCalDAVError < StandardError
+  end
+  class AuthenticationError < AgCalDAVError; end
+  class APIError            < AgCalDAVError; end
+end

data/lib/{caldav → agcaldav}/filter.rb

@@ -1,4 +1,4 @@
-module CalDAV
+module AgCalDAV
   module Filter
     class Base
       attr_accessor :parent, :child

data/lib/{caldav → agcaldav}/format.rb

@@ -1,4 +1,4 @@
-module CalDAV
+module AgCalDAV
     module Format
         class Raw
             def method_missing(m, *args, &block)

data/lib/{caldav → agcaldav}/query.rb

@@ -1,11 +1,11 @@
-module CalDAV
+module AgCalDAV
   class Query
     attr_accessor :child
     
     #TODO: raise error if to_xml is called before child is assigned
     def to_xml(xml = Builder::XmlMarkup.new(:indent => 2))
       xml.instruct!
-      xml.tag! "cal:calendar-query", CalDAV::NAMESPACES do
+      xml.tag! "cal:calendar-query", AgCalDAV::NAMESPACES do
         xml.tag! "dav:prop" do
           xml.tag! "dav:getetag"
           xml.tag! "cal:calendar-data"

data/lib/{caldav → agcaldav}/request.rb

@@ -1,6 +1,6 @@
 require 'builder'
 
-module CalDAV
+module AgCalDAV
     NAMESPACES = { "xmlns:d" => 'DAV:', "xmlns:c" => "urn:ietf:params:xml:ns:caldav" }
     module Request
         class Base

data/lib/agcaldav/version.rb

@@ -0,0 +1,3 @@
+module AgCalDAV
+    VERSION="0.2.1"
+end

data/lib/{caldav.rb → agcaldav.rb}

@@ -2,18 +2,18 @@ require 'net/https'
 require 'uuid'
 require 'rexml/document'
 require 'rexml/xpath'
-require 'date'
 require 'icalendar'
 require 'time'
+require 'date'
 
 ['client.rb', 'request.rb', 'net.rb', 'query.rb', 'filter.rb', 'format.rb'].each do |f|
-    require File.join( File.dirname(__FILE__), 'caldav', f )
+    require File.join( File.dirname(__FILE__), 'agcaldav', f )
 end
 
 class Event
-    attr_accessor :uid, :created, :dtstart, :dtend, :lastmodified, :summary, :description, :name, :action
+    attr_accessor :uid, :created, :dtstart, :dtend, :lastmodified, :summary, :description, :name, :action, :to_ical
 end
 
 class Todo
     attr_accessor :uid, :created, :summary, :dtstart, :status, :completed
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agcaldav
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-28 00:00:00.000000000 Z
+date: 2012-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: icalendar
@@ -59,23 +59,39 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: yet another new Ruby client for CalDAV calendar and tasks.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: yet another great Ruby client for CalDAV calendar and tasks.
 email: ebeling-hoppe@agilastic.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- README.rdoc
+- README.md
 - agcaldav.gemspec
-- lib/caldav.rb
-- lib/caldav/client.rb
-- lib/caldav/filter.rb
-- lib/caldav/format.rb
-- lib/caldav/net.rb
-- lib/caldav/query.rb
-- lib/caldav/request.rb
-- lib/caldav/version.rb
+- lib/agcaldav.rb
+- lib/agcaldav/client.rb
+- lib/agcaldav/filter.rb
+- lib/agcaldav/format.rb
+- lib/agcaldav/net.rb
+- lib/agcaldav/query.rb
+- lib/agcaldav/request.rb
+- lib/agcaldav/version.rb
 homepage: https://github.com/agilastic/agcaldav
 licenses:
 - MIT
@@ -100,5 +116,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: new Ruby CalDAV client
+summary: Ruby CalDAV client
 test_files: []

data/README.rdoc

@@ -1,3 +0,0 @@
-CalDAV library
-
-based on 4fthawaiian/ruby-caldav and collectiveidea/caldav and martinpovolny/ruby-caldav

data/lib/caldav/client.rb

@@ -1,214 +0,0 @@
-module CalDAV
-    class Client
-        include Icalendar
-        attr_accessor :host, :port, :url, :user, :password, :ssl
-
-        def format=( fmt )
-            @format = fmt
-        end
-
-        def format
-            @format ||= Format::Debug.new
-        end
-
-        def initialize( *args )
-            case args.length
-            when 3
-                __init_from_uri( *args )
-            when 5
-                __init_from_host_port( *args )
-            else
-                raise "#{self.class.to_s}: invalid number of arguments: #{args.length}"
-            end
-        end
-
-        def __init_from_uri( suri, user, password )
-            uri = URI( suri )
-            @host     = uri.host
-            @port     = uri.port
-            @url      = [ uri.scheme, '://', uri.host, uri.path ].join('') # FIXME: port?
-            @user     = user
-            @password = password 
-            @ssl      = uri.scheme == 'https'
-        end
-
-        def __init_from_host_port( host, port, url, user, password )
-           @host     = host
-           @port     = port
-           @url      = url
-           @user     = user
-           @password = password 
-           @ssl      = port == 443
-        end
-    
-        def __create_http
-            http = Net::HTTP.new(@host, @port)
-            http.use_ssl = @ssl
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-            #http.set_debug_output $stderr
-            http
-        end
-    
-        def report datetime_start, datetime_stop            
-            res = nil
-            __create_http.start {|http|
-                req = Net::HTTP::Report.new(@url, initheader = {'Content-Type'=>'application/xml'} )
-                req.basic_auth @user, @password
-                req.body = CalDAV::Request::ReportVEVENT.new(DateTime.parse(datetime_start).strftime("%Y%m%dT%H%M"), 
-                                                             DateTime.parse(datetime_stop).strftime("%Y%m%dT%H%M") ).to_xml
-                res = http.request( req )
-            }
-            format.parse_calendar( res.body )
-        end
-        
-        def get uuid
-            res = nil
-            __create_http.start {|http|
-                req = Net::HTTP::Get.new("#{@url}/#{uuid}.ics")
-                req.basic_auth @user, @password
-                res = http.request( req )
-            }
-
-            # FIXME: process HTTP code
-            format.parse_single( res.body )
-        end
-    
-        def delete uuid
-            __create_http.start {|http|
-                req = Net::HTTP::Delete.new("#{@url}/#{uuid}.ics")
-                req.basic_auth @user, @password
-                res = http.request( req )
-            }
-        end
-    
-        def create event
-            event.uid = UUID.generate
-            event.dtstamp = DateTime.now.strftime "%Y%m%dT%H%M%SZ"
-            event.dtstart = event.dtstart.strftime("%Y%m%dT%H%M%S")
-            event.dtend = event.dtend.strftime("%Y%m%dT%H%M%S")
-            cal = Calendar.new
-            cal.event = Event.new(event)
-            c = cal.to_ical
-            res = nil
-            http = Net::HTTP.new(@host, @port) 
-            __create_http.start { |http|
-                req = Net::HTTP::Put.new("#{@url}/#{event.uid}.ics")
-                req['Content-Type'] = 'text/calendar'
-                req.basic_auth @user, @password
-                req.body = dings
-                res = http.request( req )
-            }
-            return event.uid, res
-        end
-    
-        def add_alarm tevent, altCal="Calendar"
-        #[#<Icalendar::Alarm:0x10b9d1b90 @name=\"VALARM\", @components={}, @properties={\"trigger\"=>\"-PT5M\", \"action\"=>\"DISPLAY\", \"description\"=>\"\"}>]    
-            dtstart_string = ( Time.parse(tevent.dtstart.to_s) + Time.now.utc_offset.to_i.abs ).strftime "%Y%m%dT%H%M%S"
-            dtend_string = ( Time.parse(tevent.dtend.to_s) + Time.now.utc_offset.to_i.abs ).strftime "%Y%m%dT%H%M%S"
-            alarmText = <<EOL
-BEGIN:VCALENDAR
-VERSION:2.0
-PRODID:Ruby iCalendar
-BEGIN:VEVENT
-UID:#{tevent.uid}
-SUMMARY:#{tevent.summary}
-DESCRIPTION:#{tevent.description}
-DTSTART:#{dtstart_string}
-DTEND:#{dtend_string}
-BEGIN:VALARM
-ACTION:DISPLAY
-TRIGGER;RELATED=START:-PT5M
-DESCRIPTION:Reminder
-END:VALARM
-BEGIN:VALARM
-TRIGGER:-PT5M
-ACTION:EMAIL
-ATTENDEE:#{tevent.organizer}
-SUMMARY:#{tevent.summary}
-DESCRIPTION:#{tevent.description}
-TRIGGER:-PT5M
-END:VALARM
-END:VEVENT
-END:VCALENDAR
-EOL
-            p alarmText
-            res = nil
-            puts "#{@url}/#{tevent.uid}.ics"
-            thttp = __create_http.start
-            #thttp.set_debug_output $stderr
-            req = Net::HTTP::Put.new("#{@url}/#{tevent.uid}.ics", initheader = {'Content-Type'=>'text/calendar'} )
-            req.basic_auth @user, @password
-            req.body = alarmText
-            res = thttp.request( req )
-            p res.inspect
-    
-            return tevent.uid
-        end
-        
-        def update event
-            dings = """BEGIN:VCALENDAR
-PRODID:Caldav.rb
-VERSION:2.0
-
-BEGIN:VTIMEZONE
-TZID:/Europe/Vienna
-X-LIC-LOCATION:Europe/Vienna
-BEGIN:DAYLIGHT
-TZOFFSETFROM:+0100
-TZOFFSETTO:+0200
-TZNAME:CEST
-DTSTART:19700329T020000
-RRULE:FREQ=YEARLY;INTERVAL=1;BYDAY=-1SU;BYMONTH=3
-END:DAYLIGHT
-BEGIN:STANDARD
-TZOFFSETFROM:+0200
-TZOFFSETTO:+0100
-TZNAME:CET
-DTSTART:19701025T030000
-RRULE:FREQ=YEARLY;INTERVAL=1;BYDAY=-1SU;BYMONTH=10
-END:STANDARD
-END:VTIMEZONE
-
-BEGIN:VEVENT
-CREATED:#{event.created}
-UID:#{event.uid}
-SUMMARY:#{event.summary}
-DTSTART;TZID=Europe/Vienna:#{event.dtstart}
-DTEND;TZID=Europe/Vienna:#{event.dtend.rfc3339}
-END:VEVENT
-END:VCALENDAR"""
-    
-            res = nil
-            __create_http.start {|http|
-                req = Net::HTTP::Put.new("#{@url}/#{event.uid}.ics", initheader = {'Content-Type'=>'text/calendar'} )
-                req.basic_auth @user, @password
-                req.body = dings
-                res = http.request( req )
-            }
-            return event.uid
-        end
-    
-        def todo 
-            res = nil
-            __create_http.start {|http|
-                req = Net::HTTP::Report.new(@url, initheader = {'Content-Type'=>'application/xml'} )
-                req.basic_auth @user, @password
-                req.body = CalDAV::Request::ReportVTODO.new.to_xml
-                res = http.request( req )
-            }
-            # FIXME: process HTTP code
-            format.parse_todo( res.body )
-        end
-        
-        def filterTimezone( vcal )
-            data = ""
-            inTZ = false
-            vcal.split("\n").each{ |l| 
-                inTZ = true if l.index("BEGIN:VTIMEZONE") 
-                data << l+"\n" unless inTZ 
-                inTZ = false if l.index("END:VTIMEZONE") 
-            }
-            return data
-        end
-    end
-end

data/lib/caldav/version.rb

@@ -1,3 +0,0 @@
-module CalDAV
-    VERSION=0.2
-end