viewpoint 0.0.5 → 0.1.0

data/preamble

@@ -1,5 +1,5 @@
 #############################################################################
-# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
+# Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
 #
 #
 # This file is part of Viewpoint.

data/test/spec/basic_functions.spec

@@ -0,0 +1,51 @@
+$: << File.dirname(__FILE__) + '/../../lib/'
+require 'kconv'
+require 'viewpoint'
+require 'json'
+
+# To run this test put a file called 'creds.json' in this directory with the following format:
+#   {"user":"myuser","pass":"mypass","endpoint":"https://mydomain.com/ews/exchange.asmx"}
+
+
+describe "Test the basic features of Viewpoint" do
+  before(:all) do
+    creds = JSON.load(File.open('spec/creds.json','r'))
+    Viewpoint::EWS::EWS.endpoint = creds['endpoint']
+    Viewpoint::EWS::EWS.set_auth(creds['user'],creds['pass'])
+    @ews = Viewpoint::EWS::EWS.instance
+  end
+
+  it 'should retrieve the various Folder Types' do
+    (Viewpoint::EWS::GenericFolder.get_folder :inbox).should be_instance_of(Viewpoint::EWS::Folder)
+    (Viewpoint::EWS::GenericFolder.get_folder :calendar).should be_instance_of(Viewpoint::EWS::CalendarFolder)
+    (Viewpoint::EWS::GenericFolder.get_folder :contacts).should be_instance_of(Viewpoint::EWS::ContactsFolder)
+    (Viewpoint::EWS::GenericFolder.get_folder :tasks).should be_instance_of(Viewpoint::EWS::TasksFolder)
+  end
+
+  it 'should retrieve an Array of Folder Types' do
+    flds = Viewpoint::EWS::GenericFolder.find_folders
+    flds.should be_instance_of(Array)
+    flds.first.should be_kind_of(Viewpoint::EWS::GenericFolder)
+  end
+
+  it 'should retrieve messages from a mail folder' do
+    inbox = Viewpoint::EWS::GenericFolder.get_folder :inbox
+    msgs  = inbox.find_items
+    msgs.should be_instance_of(Array)
+    if(msgs.length > 0)
+      msgs.first.should be_kind_of(Viewpoint::EWS::Item)
+    end
+  end
+
+  it 'should retrieve an item by id if one exists' do
+    inbox = Viewpoint::EWS::GenericFolder.get_folder :inbox
+    msgs  = inbox.find_items
+    if(msgs.length > 0)
+      item = inbox.get_item(msgs.first.id)
+      item.should be_kind_of(Viewpoint::EWS::Item)
+    else
+      msgs.should be_empty
+    end
+  end
+
+end

data/test/spec/folder_subscriptions.spec

@@ -0,0 +1,35 @@
+$: << File.dirname(__FILE__) + '/../../lib/'
+require 'kconv'
+require 'viewpoint'
+require 'json'
+
+# To run this test put a file called 'creds.json' in this directory with the following format:
+#   {"user":"myuser","pass":"mypass","endpoint":"https://mydomain.com/ews/exchange.asmx"}
+
+
+describe "Folder Subscriptions" do
+  before(:all) do
+    creds = JSON.load(File.open('spec/creds.json','r'))
+    Viewpoint::EWS::EWS.endpoint = creds['endpoint']
+    Viewpoint::EWS::EWS.set_auth(creds['user'],creds['pass'])
+    @ews = Viewpoint::EWS::EWS.instance
+    @inbox = Viewpoint::EWS::GenericFolder.get_folder :inbox
+  end
+
+  describe "Example Folder Subscription for the Inbox" do
+
+    it 'should subscribe to the Inbox Folder' do
+      @inbox.subscribe.should be_true
+    end
+
+    it 'should retrieve new subscription events' do
+      @inbox.get_events.should_not be_empty
+    end
+
+    it 'should unsubscribe to the Inbox Folder' do
+      @inbox.unsubscribe.should be_true
+    end
+
+  end
+
+end

data/test/spec/folder_synchronization.spec

@@ -0,0 +1,28 @@
+$: << File.dirname(__FILE__) + '/../../lib/'
+require 'kconv'
+require 'viewpoint'
+require 'json'
+
+# To run this test put a file called 'creds.json' in this directory with the following format:
+#   {"user":"myuser","pass":"mypass","endpoint":"https://mydomain.com/ews/exchange.asmx"}
+
+
+describe "Folder Synchronization" do
+  before(:all) do
+    creds = JSON.load(File.open('spec/creds.json','r'))
+    Viewpoint::EWS::EWS.endpoint = creds['endpoint']
+    Viewpoint::EWS::EWS.set_auth(creds['user'],creds['pass'])
+    @ews = Viewpoint::EWS::EWS.instance
+    @inbox = Viewpoint::EWS::GenericFolder.get_folder :inbox
+  end
+
+  describe "Example Folder Synchronization for the Inbox" do
+
+    it 'should start synchronization of the Inbox Folder' do
+      @inbox.sync_items!(2)
+      @inbox.sync_state.should_not be_nil
+    end
+
+  end
+
+end

data/utils/ewsWSDL2rb.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'nokogiri'
+
+wsdl = Nokogiri::XML(File.read('Services.wsdl'))
+
+methods = []
+
+wsdl.xpath('//wsdl:binding/wsdl:operation').each do |op|
+  meth_name = op[:name].gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+  methods << meth_name
+  str = "  def #{meth_name}\n"
+  str << "    action = '#{op.xpath('soap:operation').first[:soapAction]}'\n"
+  str << "    resp = invoke('tns:#{op[:name]}', :soap_action => action) do |#{meth_name}|\n"
+  str << "      build_#{meth_name}!(#{meth_name})\n"
+  str << "    end\n"
+  str << "    parse_#{meth_name}(resp)\n"
+  str << "  end\n\n"
+  puts str
+end
+
+puts "\n\n  ## Helper methods (builders and parsers)\n"
+puts "  private\n\n"
+methods.each do |meth|
+  str =  "  def build_#{meth}!(#{meth})\n"
+  str << "  end\n\n"
+  str << "  def parse_#{meth}()\n"
+  str << "  end\n\n"
+  puts str
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: viewpoint
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dan Wanek
@@ -9,40 +14,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 -06:00
+date: 2010-08-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: soap4r
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: handsoap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.8
-    version: 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: icalendar
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rubyntlm
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: icalendar
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.1
-    version: 
-description: "  \tA Ruby client access library for Microsoft Exchange Web Services (EWS).  It is a work in progress.  Methods are still being added from the EWS API docs.  Please see them for further information: http://msdn.microsoft.com/en-us/library/bb204119.aspx\n"
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: "  \tA Ruby client access library for Microsoft Exchange Web Services (EWS).  Examples can be found here: http://distributed-frostbite.blogspot.com\n"
 email: dan.wanek@gmail.com
 executables: []
 
@@ -55,6 +95,7 @@ files:
 - COPYING.txt
 - README
 - Rakefile
+- TODO
 - VERSION
 - examples/cal2ical.rb
 - examples/ews_fusefs.rb
@@ -102,58 +143,75 @@ files:
 - examples/webclient/views/layout.haml
 - examples/webclient/views/mail.haml
 - examples/webclient/views/welcome.haml
-- lib/exchwebserv.rb
-- lib/soap/viewpoint.conf
+- lib/exceptions/exceptions.rb
+- lib/extensions/string.rb
+- lib/model/calendar_folder.rb
+- lib/model/calendar_item.rb
+- lib/model/contact.rb
+- lib/model/contacts_folder.rb
+- lib/model/distribution_list.rb
+- lib/model/event.rb
+- lib/model/folder.rb
+- lib/model/generic_folder.rb
+- lib/model/item.rb
+- lib/model/mailbox_user.rb
+- lib/model/meeting_cancellation.rb
+- lib/model/meeting_message.rb
+- lib/model/meeting_request.rb
+- lib/model/meeting_response.rb
+- lib/model/message.rb
+- lib/model/model.rb
+- lib/model/search_folder.rb
+- lib/model/task.rb
+- lib/model/task_list.rb
+- lib/model/tasks_folder.rb
+- lib/soap/handsoap/builder.rb
+- lib/soap/handsoap/builders/ews_build_helpers.rb
+- lib/soap/handsoap/builders/ews_builder.rb
+- lib/soap/handsoap/ews_service.rb
+- lib/soap/handsoap/parser.rb
+- lib/soap/handsoap/parsers/ews_parser.rb
+- lib/soap/soap_provider.rb
 - lib/viewpoint.rb
-- lib/viewpoint/calendar.rb
-- lib/viewpoint/calendar_item.rb
-- lib/viewpoint/errors.rb
-- lib/viewpoint/event.rb
-- lib/viewpoint/exchange_headers.rb
-- lib/viewpoint/exchwebserv.rb
-- lib/viewpoint/folder.rb
-- lib/viewpoint/item.rb
-- lib/viewpoint/mail.rb
-- lib/viewpoint/message.rb
-- lib/viewpoint/task.rb
-- lib/viewpoint/tasks.rb
-- lib/wsdl/defaultMappingRegistry.rb
-- lib/wsdl/exchangeServiceBinding.rb
-- lib/wsdl/exchangeServiceTypes.rb
 - preamble
-- test/spec/basic_features_spec.rb
-- test/test_client.rb
-- test/testrestrict.rb
+- test/spec/basic_functions.spec
+- test/spec/folder_subscriptions.spec
+- test/spec/folder_synchronization.spec
+- utils/ewsWSDL2rb.rb
 has_rdoc: true
 homepage: http://github.com/zenchild/Viewpoint
 licenses: []
 
-post_install_message: Don't forget to create .viewpointrc.  See README
+post_install_message: 
 rdoc_options: 
 - -x
-- wsdl/
-- -x
 - test/
 - -x
 - examples/
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
       version: 1.8.7
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby client access library for Microsoft Exchange Web Services (EWS)

data/lib/exchwebserv.rb

@@ -1,6 +0,0 @@
-# This exists for legacy reasons and will be depreciated soon
-warn "*******************************************"
-warn "Requiring exchwebserv is depreciated and will be removed soon.\nPlease require 'viewpoint'"
-warn "*******************************************"
-
-require 'viewpoint'

data/lib/soap/viewpoint.conf

@@ -1,3 +0,0 @@
-exchange.ews.user=user
-exchange.ews.pass=pass
-exchange.ews.endpoint=https://hostname/ews/exchange.asmx

data/lib/viewpoint/calendar.rb

@@ -1,128 +0,0 @@
-#############################################################################
-# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
-#
-#
-# This file is part of Viewpoint.
-# 
-# Viewpoint is free software: you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or (at
-# your option) any later version.
-# 
-# Viewpoint is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
-# Public License for more details.
-# 
-# You should have received a copy of the GNU General Public License along
-# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
-#############################################################################
-$:.unshift(File.dirname(__FILE__))
-require 'rubygems'
-require 'icalendar'
-require 'wsdl/exchangeServiceBinding'
-# --- Folder Types ---
-require 'folder'
-# --- Item Types ---
-require 'calendar_item'
-#require 'meeting_request'
-
-
-
-class Viewpoint::CalendarFolder < Viewpoint::Folder
-	include Viewpoint
-
-	# initialize with an item of CalendarFolderType
-	def initialize(folder)
-		# Call initialize in the 
-		super(folder)
-	end
-
-	def get_todays_events
-		get_events(DateTime.parse(Date.today.to_s), DateTime.parse(Date.today.next.to_s))
-	end
-
-	def get_weeks_events
-		start_date = Date.today
-		end_date = (start_date + ( 6 - start_date.wday))
-
-		get_events(DateTime.parse(start_date.to_s), DateTime.parse(end_date.to_s))
-	end
-
-	# Get events between a certain time period.  Defaults to "today"
-	# Input: DateTime of start, DateTime of end
-	# You can get a year of events by passing 'nil, nil', but you should really consider using synchronization then.
-	# This method will return an Array of CalendarItem
-	def get_events(start_time = (DateTime.parse(Date.today.to_s)), end_time = (DateTime.parse(Date.today.next.to_s)))
-		find_item_t = FindItemType.new
-		find_item_t.xmlattr_Traversal = ItemQueryTraversalType::Shallow
-		item_shape = ItemResponseShapeType.new(DefaultShapeNamesType::Default, false)
-
-		find_item_t.itemShape = item_shape
-		
-		folder_ids = NonEmptyArrayOfBaseFolderIdsType.new()
-		dist_folder = DistinguishedFolderIdType.new
-		dist_folder.xmlattr_Id = DistinguishedFolderIdNameType.new(@display_name.downcase)
-		folder_ids.distinguishedFolderId = dist_folder
-		find_item_t.parentFolderIds = folder_ids
-		
-		# If we pass nil, force times to be:
-		# 	start:  1 years ago
-		# 	end:	1 years from now
-		cal_span =  CalendarViewType.new
-		if ( start_time == nil or end_time == nil)
-			cal_span.xmlattr_StartDate = DateTime.parse((Date.today - 365).to_s).to_s
-			cal_span.xmlattr_EndDate = DateTime.parse((Date.today + 365).to_s).to_s
-			find_item_t.calendarView = cal_span
-		else
-			cal_span.xmlattr_StartDate = start_time.to_s
-			cal_span.xmlattr_EndDate = end_time.to_s
-			find_item_t.calendarView = cal_span
-		end
-
-		resp = find_items(find_item_t)
-		if resp != nil
-			cal_items = []
-
-			resp.rootFolder.items.calendarItem.each do |cali|
-				cal_items << CalendarItem.new(cali, self)
-			end
-			# TODO: Handle the following types of Calendar data
-			# meetingMessage
-			# meetingRequest
-			# meetingResponse
-			# meetingCancellation
-
-			return cal_items
-		else
-			return resp  # return nil
-		end
-	end
-
-
-	# Returns an Icalendar::Calendar object
-	# Input: DateTime of start, DateTime of end
-	def to_ical(dtstart = nil, dtend = nil)
-		ical = Icalendar::Calendar.new
-		events = get_events(dtstart, dtend)
-		events.each do |ev|
-			ical.add_event(ev.to_ical_event)
-		end
-		return ical
-	end
-
-
-	# See docs for Folder::get_item
-	def get_item(item_id)
-		cali = super(item_id, "calendarItem", true)
-	end
-
-  def get_event(item_id)
-    begin
-      return CalendarItem.new(get_item(item_id), self)
-    rescue InvalidEWSItemError => e
-      return nil
-    end
-  end
-end
-