ews-api 0.1.0.a

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+doc
+.yardoc
+
+## PROJECT::SPECIFIC
+spec/test-config.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeremy Burks
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,38 @@
+= ews-api
+
+Exchange Web Services API.
+
+== Configuration
+
+Set the endpoint
+
+  EWS::Service.endpoint :uri => 'https://example.com/ews/exchange.asmx',
+                        :version => 1         
+ 
+Set the credentials if the service requires autentication. NTLM is known to work.
+
+  EWS::Service.set_auth 'testuser', 'xxxxxx'
+
+== Testing
+
+Typically it isn't a good idea for tests to depend on external resources.
+This project is in its early days and I am new to EWS. So as to make it
+easier to implement the service the tests depend on connecting to EWS.
+
+If +spec/test-config+ exists it will be loaded and the +EWS::Service+ will
+be configured.
+
+The config file is ignored via +.gitignore+.
+
+=== Example +spec/test-config.yml+
+
+  # Example spec/test-config.yml
+  endpoint:
+    :uri: 'https://localhost/ews/exchange.asmx'
+    :version: 1
+  username: testuser
+  password: xxxxxx
+
+== Copyright
+
+Copyright (c) 2009 Jeremy Burks. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ews-api"
+    gem.summary = 'Exchange Web Services API'
+    gem.description = "Exchange Web Services API. It doesn't use soap4r."
+    gem.email = "jeremy.burks@gmail.com"
+    gem.homepage = "http://github.com/jrun/ews-api"
+    gem.authors = ["jrun"]
+    gem.add_dependency 'httpclient'
+    gem.add_dependency 'rubyntlm'
+    gem.add_dependency 'handsoap', '1.1.4'
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+
+    desc "Install development dependencies."
+    task :setup do
+      gems = ::Gem::SourceIndex.from_installed_gems
+      gem.dependencies.each do |dep|
+        if gems.find_name(dep.name, dep.version_requirements).empty?
+          puts "Installing dependency: #{dep}"
+          system %Q|gem install #{dep.name} -v "#{dep.version_requirements}" --development|
+        end
+      end
+    end
+    
+    desc "Build and reinstall the gem locally."
+    task :reinstall => :build do
+      version = File.read('VERSION')
+      if (system("gem list #{gem.name} -l") || "") =~ /#{gem.name}-#{version}/
+        system "gem uninstall #{gem.name}"
+      end
+      system "gem install --no-rdoc --no-ri -l pkg/#{gem.name}-#{version}"
+    end
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Run tests against a real EWS server'
+Spec::Rake::SpecTask.new(:integration) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/integration.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+task :build => [:spec, :yard]
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+begin
+  require 'grancher/task'
+  Grancher::Task.new do |g|
+    g.branch = 'gh-pages'
+    g.push_to = 'origin'
+    g.directory 'doc'
+  end
+rescue LoadError
+  task :publish do
+    abort "grancher is not available. Run 'rake setup' to install all development dependencies."
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0.a

data/ews-api.gemspec

@@ -0,0 +1,96 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ews-api}
+  s.version = "0.1.0.a"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jrun"]
+  s.date = %q{2009-12-17}
+  s.description = %q{Exchange Web Services API. It doesn't use soap4r.}
+  s.email = %q{jeremy.burks@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ews-api.gemspec",
+     "lib/ews-api.rb",
+     "lib/ews/attachment.rb",
+     "lib/ews/error.rb",
+     "lib/ews/folder.rb",
+     "lib/ews/message.rb",
+     "lib/ews/model.rb",
+     "lib/ews/parser.rb",
+     "lib/ews/service.rb",
+     "spec/ews/attachment_spec.rb",
+     "spec/ews/folder_spec.rb",
+     "spec/ews/message_spec.rb",
+     "spec/ews/model_spec.rb",
+     "spec/ews/parser_spec.rb",
+     "spec/ews/service_spec.rb",
+     "spec/fixtures/find_folder.xml",
+     "spec/fixtures/find_item.xml",
+     "spec/fixtures/find_item_all_properties.xml",
+     "spec/fixtures/get_attachment.xml",
+     "spec/fixtures/get_folder.xml",
+     "spec/fixtures/get_item_all_properties.xml",
+     "spec/fixtures/get_item_default.xml",
+     "spec/fixtures/get_item_id_only.xml",
+     "spec/fixtures/get_item_no_attachments.xml",
+     "spec/fixtures/get_item_with_error.xml",
+     "spec/integration.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jrun/ews-api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Exchange Web Services API}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/integration.rb",
+     "spec/ews/parser_spec.rb",
+     "spec/ews/message_spec.rb",
+     "spec/ews/attachment_spec.rb",
+     "spec/ews/folder_spec.rb",
+     "spec/ews/service_spec.rb",
+     "spec/ews/model_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httpclient>, [">= 0"])
+      s.add_runtime_dependency(%q<rubyntlm>, [">= 0"])
+      s.add_runtime_dependency(%q<handsoap>, ["= 1.1.4"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<httpclient>, [">= 0"])
+      s.add_dependency(%q<rubyntlm>, [">= 0"])
+      s.add_dependency(%q<handsoap>, ["= 1.1.4"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httpclient>, [">= 0"])
+    s.add_dependency(%q<rubyntlm>, [">= 0"])
+    s.add_dependency(%q<handsoap>, ["= 1.1.4"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/ews-api.rb

@@ -0,0 +1,16 @@
+require 'net/ntlm'
+require 'handsoap'
+
+require 'ews/error'
+require 'ews/model'
+require 'ews/attachment'
+require 'ews/message'
+require 'ews/folder'
+require 'ews/parser'
+require 'ews/service'
+
+module EWS
+  def self.inbox
+    Service.get_folder(:inbox, :base_shape => :AllProperties)
+  end
+end

data/lib/ews/attachment.rb

@@ -0,0 +1,7 @@
+module EWS
+  class Attachment < Model
+    def id
+      attrs[:attachment_id]
+    end
+  end
+end

data/lib/ews/error.rb

@@ -0,0 +1,14 @@
+module EWS
+  
+  class Error < StandardError
+  end
+  
+  class ResponseError < Error
+    attr_reader :response_code
+
+    def initialize(message, response_code)
+      super message
+      @response_code = response_code
+    end
+  end
+end

data/lib/ews/folder.rb

@@ -0,0 +1,44 @@
+module EWS  
+
+  class Folder < Model
+    def id
+      attrs[:folder_id][:id]
+    end
+
+    def change_key
+      attrs[:folder_id][:change_key]
+    end
+
+    def name
+      attrs[:display_name]
+    end
+
+    def each_message
+      items.each {|message| yield message }
+    end
+
+    def folders
+      @folders ||= find_folders.inject({}) do |folders, folder|
+        folders[folder.name] = folder
+        folders
+      end
+    end
+
+    def items
+      @items ||= find_folder_items
+    end
+    
+    private
+    def find_folder_items
+      # NOTE: This assumes Service#find_item only returns
+      # Messages. That is true now but will change as more
+      # of the parser is implemented.
+      service.find_item(self.name, :base_shape => :AllProperties)
+    end
+
+    def find_folders
+      service.find_folder(self.name)
+    end
+  end
+  
+end

data/lib/ews/message.rb

@@ -0,0 +1,22 @@
+module EWS
+  
+  class Message < Model
+    def id
+      @id ||= attrs[:item_id][:id]
+    end
+
+    def change_key
+      @change_key ||= attrs[:item_id][:change_key]
+    end
+    
+    def shallow?
+      self.body.nil? || self.header.nil?
+    end
+
+    def move_to!(folder_id)
+      # TODO: support DistinguishedFolderId?
+      service.move_item! folder_id, [self.id]
+    end
+  end
+  
+end

data/lib/ews/model.rb

@@ -0,0 +1,37 @@
+module EWS
+    
+  class Model
+    def initialize(attrs = {})
+      @attrs = attrs.dup
+    end
+
+    def shallow?
+      raise NotImplementedError, "Each model must determine when it is shallow."
+    end
+    
+    protected
+    attr_reader :attrs
+    
+    def service
+      EWS::Service
+    end
+
+    public
+    def method_missing(meth, *args)
+      method_name = meth.to_s
+      if method_name.end_with?('=')
+        attr = method_name.chomp('=').to_sym
+        @attrs[attr] = args.first        
+      elsif method_name.end_with?('?')        
+        attr = method_name.chomp('?').to_sym
+        @attrs[attr] == true        
+      elsif @attrs.has_key?(meth)        
+        @attrs[meth]        
+      else
+        super meth, *args
+      end
+    end
+    
+  end
+  
+end

data/lib/ews/parser.rb

@@ -0,0 +1,166 @@
+module EWS
+  
+  class Parser
+    def parse_find_folder(doc)
+      doc.xpath('//t:Folders/child::*').map do |node|
+        parse_exchange_folder node.xpath('.') # force NodeSelection
+      end.compact
+    end
+    
+    def parse_get_folder(doc)
+      parse_exchange_folder doc.xpath('//m:Folders/child::*[1]')
+    end
+    
+    def parse_find_item(doc)
+      doc.xpath('//t:Items/child::*').map do |node|
+        parse_exchange_item node.xpath('.') # force NodeSelection
+      end.compact
+    end
+    
+    def parse_get_item(doc)      
+      parse_exchange_item doc.xpath('//m:Items/child::*[1]')
+    end
+
+    def parse_get_attachment(doc)
+      parse_attachment doc.xpath('//m:Attachments/child::*[1]')
+    end
+    
+    # Checks the ResponseMessage for errors.
+    #
+    # @see http://msdn.microsoft.com/en-us/library/aa494164%28EXCHG.80%29.aspx
+    # Exhange 2007 Valid Response Messages
+    def parse_response_message(doc)      
+      error_node = doc.xpath('//m:ResponseMessages/child::*[@ResponseClass="Error"]')
+      unless error_node.empty?
+        error_msg = error_node.xpath('m:MessageText/text()').to_s
+        response_code = error_node.xpath('m:ResponseCode/text()').to_s
+        raise EWS::ResponseError.new(error_msg, response_code)
+      end
+    end
+
+    private
+    def parse_exchange_folder(folder_node)
+      case folder_node.node_name
+      when 'Folder'
+        parse_folder folder_node
+      when 'CalendarFolder'
+      when 'ContactsFolder'
+      when 'SearchFolder'
+      when 'TasksFolder'
+      else
+        nil
+      end
+    end
+    
+    def parse_folder(folder_node)
+      attrs = {
+        :folder_id          => parse_id(folder_node.xpath('t:FolderId')),
+        :display_name       => folder_node.xpath('t:DisplayName/text()').to_s,
+        :total_count        => folder_node.xpath('t:TotalCount/text()').to_i,
+        :child_folder_count => folder_node.xpath('t:ChildFolderCount/text()').to_i,
+        :unread_count       => folder_node.xpath('t:UnreadCount/text()').to_i
+      }   
+      Folder.new attrs
+    end
+    
+    def parse_exchange_item(item_node)
+      case item_node.node_name
+      when 'Item'
+      when 'Message'
+        parse_message item_node
+      when 'CalendarItem'
+      when 'Contact'
+      when 'Task'
+      when 'MeetingMessage'
+      when 'MeetingRequest'
+      when 'MeetingResponse'
+      when 'MeetingCancellation'
+      else
+        nil
+      end
+    end
+      
+    def parse_message(message_node)
+      attrs = {
+        :item_id          => parse_id(message_node.xpath('t:ItemId')),
+        :parent_folder_id => parse_id(message_node.xpath('t:ParentFolderId')),
+        :subject          => message_node.xpath('t:Subject/text()').to_s,
+        :body             => message_node.xpath('t:Body/text()').to_s,
+        :body_type        => message_node.xpath('t:Body/@BodyType').to_s
+      }
+
+      nodeset = message_node.xpath('t:HasAttachments')
+      attrs[:has_attachments] = if not nodeset.empty?
+        parse_bool(nodeset)
+      end
+      
+      nodeset = message_node.xpath('t:Attachments')
+      attrs[:attachments] = if not nodeset.empty?
+        nodeset.xpath('t:ItemAttachment|t:FileAttachment').map do |node|
+          parse_attachment node
+        end
+      end
+
+      nodeset = message_node.xpath('t:InternetMessageHeaders')
+      attrs[:header] = if not nodeset.empty?
+        parse_header nodeset
+      end
+   
+      Message.new attrs
+    end
+
+    EXCHANGE_ITEM_XPATH = ['t:Item',
+                           't:Message',
+                           't:CalendarItem',
+                           't:Contact',
+                           't:Task',
+                           't:MeetingMessage',
+                           't:MeetingRequest',
+                           't:MeetingResponse',
+                           't:MeetingCancellation'].join('|').freeze
+    
+    def parse_attachment(attachment_node)
+      attrs = {
+        :attachment_id => attachment_node.xpath('t:AttachmentId/@Id').to_s,
+        :name          => attachment_node.xpath('t:Name/text()').to_s,
+        :content_type  => attachment_node.xpath('t:ContentType/text()').to_s,
+        :content_id    => attachment_node.xpath('t:ContentId/text()').to_s,
+        :content_location => attachment_node.xpath('t:ContentLocation/text()').to_s
+      }
+      
+      case attachment_node.node_name
+      when 'ItemAttachment'
+        attrs[:item] = parse_exchange_item attachment_node.xpath(EXCHANGE_ITEM_XPATH)
+      when 'FileAttachment'
+      end
+      
+      Attachment.new attrs
+    end
+
+    def parse_header(header_node)
+      header_node.xpath('t:InternetMessageHeader').inject({}) do |header, node|
+        name = node.xpath('@HeaderName').to_s.downcase
+        header[name] = [] unless header.has_key?(name)          
+        header[name] << node.xpath('text()').to_s        
+        header
+      end
+    end
+    
+    def parse_id(id_node)
+      return nil if id_node.empty?
+      { :id         => id_node.xpath('@Id').to_s,
+        :change_key => id_node.xpath('@ChangeKey').to_s }
+    end
+
+    def parse_bool(val)
+      case val.to_s.downcase
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        nil
+      end
+    end
+  end
+end