rews 0.2.12 → 0.5.0

data/README.rdoc

@@ -29,15 +29,20 @@ to use :
                             :indexed_page_item_view=>{:max_entries_returned=>10, :offset=>0})
 
   # get some properties for a bunch of messages in one hit
-  messages = inbox.get_item(mids, :item_shape=>{
-                                    :base_shape=>:IdOnly,
-                                    :additional_properties=>[
-                                      [:field_uri, "item:Subject"],
-                                      [:field_uri, "item:DateTimeReceived"],
-                                      [:field_uri, "message:InternetMessageId"]]})
+  messages = c.get_item(mids, :item_shape=>{
+                                :base_shape=>:IdOnly,
+                                :additional_properties=>[
+                                  [:field_uri, "item:Subject"],
+                                  [:field_uri, "item:DateTimeReceived"],
+                                  [:field_uri, "message:InternetMessageId"],
+                                  [:field_uri, "message:IsRead"],
+                                  [:field_uri, "message:IsReadReceiptRequested"]]})
+
+  # suppress read receipts on any messages which have requested them
+  c.suppress_read_receipt(messages)
 
   # delete the items to the DeletedItems folder
-  inbox.delete_item(mids, :delete_type=>:MoveToDeletedItems)
+  c.delete_item(mids, :delete_type=>:MoveToDeletedItems)
 
 == Install
 

data/Rakefile

@@ -13,10 +13,12 @@ begin
     gem.add_dependency "savon", ">= 0.8.6"
     gem.add_dependency "ntlm-http", ">= 0.1.2"
     gem.add_dependency "fetch_in", ">= 0.2.0"
+    gem.add_runtime_dependency "rsxml", ">= 0.1.4"
     gem.add_development_dependency "httpclient", ">= 2.1.7"
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "rr", ">= 0.10.5"
     gem.add_development_dependency "nokogiri", ">= 1.4.4"
+
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.12
+0.5.0

data/lib/rews.rb

@@ -4,18 +4,36 @@ require 'net/ntlm'
 # require 'httpclient' # don't need httpclient now ntlm-http is fixed too
 require 'savon'
 require 'fetch_in'
+require 'rsxml'
 
 # Ruby Exchange Web Services
 module Rews
   WSDL = File.expand_path("../../Services.wsdl", __FILE__)
   SCHEMA_MESSAGES = "http://schemas.microsoft.com/exchange/services/2006/messages"
   SCHEMA_TYPES = "http://schemas.microsoft.com/exchange/services/2006/types"
+
+  class << self
+    attr_accessor :logdev
+  end
+
+  module_function
+
+  def logger
+    return @logger if @logger
+    @logger = Logger.new(logdev) if logdev
+  end
+
+  def log
+    yield(logger) if logger
+    nil
+  end
 end
 
 require 'rews/util'
 require 'rews/restriction'
 require 'rews/shape'
 require 'rews/sort_order'
+require 'rews/update'
 require 'rews/view'
 require 'rews/folder'
 require 'rews/item'

data/lib/rews/client.rb

@@ -1,11 +1,12 @@
 module Rews
   class Client
+    include Util
+
     attr_reader :endpoint
     attr_reader :auth_type
     attr_reader :user
     attr_reader :password
     attr_reader :savon_client
-    attr_accessor :logdev
 
     # create a +Client+ to access Exchange Web Services
     # * using NTLM authentication
@@ -39,14 +40,181 @@ module Rews
       Folder::DistinguishedFolderId.new(self, id, mailbox_email)
     end
 
-    # yield a +Logger+ if +logdev+ has been set
-    def log
-      yield logger if @logdev
+    CREATE_ITEM_OPTS={
+      :items=>nil,
+      :message_disposition=>nil,
+      :send_meeting_invitations=>nil
+    }
+
+    # create items, specifying a list of Rsxml expressions, one for each item in the Items list e.g.
+    # 
+    #  client.create_item(:items=>[[:suppress_read_receipt, [:reference_item_id, {:id=>"abc", :change_key=>"def"}]]])
+    def create_item(opts={})
+      opts = check_opts(CREATE_ITEM_OPTS, opts)
+      
+      items = opts[:items].compact if opts[:items]
+      raise "no items!" if items.empty?
+
+      attrs = {}
+      attrs[:message_disposition] = opts[:message_disposition] if opts[:message_disposition]
+      attrs[:send_meeting_invitations] = opts[:send_meeting_invitations] if opts[:send_meeting_invitations]
+
+      r = with_error_check(self, :create_item_response, :response_messages, :create_item_response_message) do
+        savon_client.request(:wsdl, "CreateItem", attrs) do
+          http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/CreateItem\"" # required by EWS 2007
+          soap.namespaces["xmlns:t"]=SCHEMA_TYPES
+
+          xml = Builder::XmlMarkup.new
+
+          xml.wsdl :Items do
+            items.each do |item|
+              xml << Util.rsxml_to_xml(item)
+            end
+          end
+
+          soap.body = xml.target!
+        end
+      end
+      r
+    end
+
+    # +iids+ is a list of Items or ItemIds. If +iids+ is a list of Items,
+    # and those Items have +IsRead+ or +IsReadReceiptRequested+ properties then
+    # no +SuppressReadReceipt+ Item will be created if ( +IsRead+=true or
+    # +IsReadReceiptRequested+=false)
+    def suppress_read_receipt(iids)
+      items = iids.map do |item_or_item_id|
+        item_id = item_or_item_id.is_a?(Item::Item) ? item_or_item_id.item_id : item_or_item_id
+        srr = [:suppress_read_receipt, [:reference_item_id, {:id=>item_id.id, :change_key=>item_id.change_key}]]
+        if item_or_item_id.is_a?(Item::Item)
+          attributes = item_or_item_id.attributes
+          if (attributes.has_key?(:is_read) && attributes[:is_read]) || 
+              (attributes.has_key?(:is_read_receipt_requested) &&
+               !attributes[:is_read_receipt_requested])
+            next
+          else
+            srr
+          end
+        else
+          srr
+        end
+      end.compact
+      create_item(:items=>items) if items.length>0
     end
 
-    def logger
-      return @logger if @logger
-      @logger = Logger.new(@logdev) if @logdev
+    GET_ITEM_OPTS = {
+      :item_shape=>Shape::ITEM_SHAPE_OPTS,
+      :ignore_change_keys=>nil
+    }
+
+    # retrieve a bunch of <tt>Item::Item</tt>s in one API hit.
+    # takes a list of <tt>Item::ItemId</tt>s, or a list of <tt>Item::Item</tt>, 
+    # or a <tt>Folder::FindResult</tt> and options to specify +Shape::ItemShape+
+    def get_item(message_ids, opts={})
+      opts = check_opts(GET_ITEM_OPTS, opts)
+      message_ids = message_ids.result if message_ids.is_a?(Folder::FindResult)
+
+      r = with_error_check(self, :get_item_response,:response_messages,:get_item_response_message) do
+        self.savon_client.request(:wsdl, "GetItem") do
+          http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/GetItem\"" # required by EWS 2007
+          soap.namespaces["xmlns:t"]=SCHEMA_TYPES
+          
+          xml = Builder::XmlMarkup.new
+
+          xml << Shape::ItemShape.new(opts[:item_shape]||{}).to_xml
+          xml.wsdl :ItemIds do
+            message_ids.each do |mid|
+              mid = mid.item_id if mid.is_a?(Item::Item)
+              xml << mid.to_xml(opts[:ignore_change_keys])
+            end
+          end
+
+          soap.body = xml.target!
+        end
+      end
+      Item.read_get_item_response_messages(self, r)
     end
+
+
+
+    UPDATE_ITEM_OPTS = {
+      :conflict_resolution => "AutoResolve",
+      :message_disposition => "SaveOnly",
+      :ignore_change_keys=>false,
+      :updates => nil,
+    }
+
+    # bulk update a bunch of Items in one API hit
+    # takes a list of <tt>Item::ItemId</tt>s, or a list of <tt>Item::Item</tt>,
+    # or a <tt>Folder::FindResult</tt> and applies the same set of updates to each of them
+    def update_item(message_ids, opts={})
+      opts = check_opts(UPDATE_ITEM_OPTS, opts)
+      message_ids = message_ids.result if message_ids.is_a?(Folder::FindResult)
+
+      updates = [*opts[:updates]].compact
+      raise "no updates!" if updates.empty?
+      r = with_error_check(self, :update_item_response, :response_messages, :update_item_response_message) do
+        self.savon_client.request(:wsdl, "UpdateItem", 
+                                  :ConflictResolution=>opts[:conflict_resolution],
+                                  :MessageDisposition=>opts[:message_disposition]) do
+          http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/UpdateItem\"" # required by EWS 2007
+          soap.namespaces["xmlns:t"]=SCHEMA_TYPES
+          
+          xml = Builder::XmlMarkup.new
+          
+          xml.wsdl :ItemChanges do
+            message_ids.each do |mid|
+              mid = mid.item_id if mid.is_a?(Item::Item)
+              xml.t :ItemChange do
+                xml << mid.to_xml(opts[:ignore_change_keys])
+                xml.t :Updates do
+                  updates.each do |update|
+                    xml << update.to_xml
+                  end
+                end
+              end
+            end
+          end
+          
+          soap.body = xml.target!
+        end
+      end
+      r
+    end
+
+    DELETE_ITEM_OPTS = {
+      :delete_type! =>nil,
+      :ignore_change_keys=>false
+    }
+
+    # delete a bunch of Items in one API hit.
+    # takes a list of <tt>Item::ItemId</tt>s, or a list of <tt>Item::Item</tt>, 
+    # or a <tt>Folder::FindResult</tt> and options to specify DeleteType
+    def delete_item(message_ids, opts={})
+      opts = check_opts(DELETE_ITEM_OPTS, opts)
+      message_ids = message_ids.result if message_ids.is_a?(Folder::FindResult)
+
+      r = with_error_check(self, :delete_item_response, :response_messages, :delete_item_response_message) do
+        self.savon_client.request(:wsdl, "DeleteItem", :DeleteType=>opts[:delete_type]) do
+          http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/DeleteItem\"" # required by EWS 2007
+          soap.namespaces["xmlns:t"]=SCHEMA_TYPES
+          
+          xml = Builder::XmlMarkup.new
+
+          xml.wsdl :ItemIds do
+            message_ids.each do |mid|
+              mid = mid.item_id if mid.is_a?(Item::Item)
+              xml << mid.to_xml(opts[:ignore_change_keys])
+            end
+          end
+
+          soap.body = xml.target!
+        end
+      end
+      true
+    end
+
+    
+
   end
 end

data/lib/rews/folder.rb

@@ -189,70 +189,7 @@ module Rews
         r
       end
 
-      GET_ITEM_OPTS = {
-        :item_shape=>Shape::ITEM_SHAPE_OPTS,
-        :ignore_change_keys=>nil
-      }
-
-      # retrieve a bunch of <tt>Item::Item</tt>s in one API hit.
-      # takes a list of <tt>Item::ItemId</tt>s, or a list of <tt>Item::Item</tt>, 
-      # or a <tt>Folder::FindResult</tt> and options to specify +Shape::ItemShape+
-      def get_item(message_ids, opts={})
-        opts = check_opts(GET_ITEM_OPTS, opts)
-        message_ids = message_ids.result if message_ids.is_a?(FindResult)
-
-        r = with_error_check(client, :get_item_response,:response_messages,:get_item_response_message) do
-          client.savon_client.request(:wsdl, "GetItem") do
-            http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/GetItem\"" # required by EWS 2007
-            soap.namespaces["xmlns:t"]=SCHEMA_TYPES
-            
-            xml = Builder::XmlMarkup.new
-
-            xml << Shape::ItemShape.new(opts[:item_shape]||{}).to_xml
-            xml.wsdl :ItemIds do
-              message_ids.each do |mid|
-                mid = mid.item_id if mid.is_a?(Item::Item)
-                xml << mid.to_xml(opts[:ignore_change_keys])
-              end
-            end
-
-            soap.body = xml.target!
-          end
-        end
-        Item.read_get_item_response_messages(client, r)
-      end
 
-      DELETE_ITEM_OPTS = {
-        :delete_type! =>nil,
-        :ignore_change_keys=>false
-      }
-
-      # delete a bunch of Items in one API hit.
-      # takes a list of <tt>Item::ItemId</tt>s, or a list of <tt>Item::Item</tt>, 
-      # or a <tt>Folder::FindResult</tt> and options to specify DeleteType
-      def delete_item(message_ids, opts={})
-        opts = check_opts(DELETE_ITEM_OPTS, opts)
-        message_ids = message_ids.result if message_ids.is_a?(FindResult)
-
-        r = with_error_check(client, :delete_item_response, :response_messages, :delete_item_response_message) do
-          client.savon_client.request(:wsdl, "DeleteItem", :DeleteType=>opts[:delete_type]) do
-            http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/DeleteItem\"" # required by EWS 2007
-            soap.namespaces["xmlns:t"]=SCHEMA_TYPES
-            
-            xml = Builder::XmlMarkup.new
-
-            xml.wsdl :ItemIds do
-              message_ids.each do |mid|
-                mid = mid.item_id if mid.is_a?(Item::Item)
-                xml << mid.to_xml(opts[:ignore_change_keys])
-              end
-            end
-
-            soap.body = xml.target!
-          end
-        end
-        true
-      end
     end
 
     # identifies a regular (non-distinguished) Folder on an Exchange server

data/lib/rews/item.rb

@@ -32,7 +32,7 @@ module Rews
         @client = client
         @item_id = ItemId.new(client, attributes[:item_id])
         @item_class = item_class
-        @attributes = attributes
+        @attributes = attributes || {}
       end
 
       def ==(other)
@@ -134,6 +134,51 @@ module Rews
         true
       end
 
+      UPDATE_ITEM_OPTS = {
+        :conflict_resolution => "AutoResolve",
+        :message_disposition => "SaveOnly",
+        :ignore_change_keys=>false,
+        :updates => nil,
+      }
+
+      def update_item(opts={})
+        opts = check_opts(UPDATE_ITEM_OPTS, opts)
+        updates = [*opts[:updates]].compact
+        raise "no updates!" if updates.empty?
+        r = with_error_check(client, :update_item_response, :response_messages, :update_item_response_message) do
+          client.savon_client.request(:wsdl, "UpdateItem", 
+                                      :ConflictResolution=>opts[:conflict_resolution],
+                                      :MessageDisposition=>opts[:message_disposition]) do
+            http.headers["SOAPAction"] = "\"#{SCHEMA_MESSAGES}/UpdateItem\"" # required by EWS 2007
+            soap.namespaces["xmlns:t"]=SCHEMA_TYPES
+            
+            xml = Builder::XmlMarkup.new
+            
+            xml.wsdl :ItemChanges do
+              xml.t :ItemChange do
+                xml << self.to_xml(opts[:ignore_change_keys])
+                xml.t :Updates do
+                    updates.each do |update|
+                    xml << update.to_xml
+                  end
+                end
+              end
+            end
+            
+            soap.body = xml.target!
+          end
+        end
+        r
+      end
+
+      # sets message:isReadReceiptRequested and message:isDeliveryReceiptRequested
+      # properties of a message to false
+      def set_is_read(is_read=true)
+        update_item(:conflict_resolution=>"AlwaysOverwrite",
+                    :message_disposition=>"SaveOnly",
+                    :updates=>[SetItemField.new("message:IsRead", [:message,[:is_read, is_read.to_s]])])
+      end
+
       def to_xml(ignore_change_key=false)
         xml = Builder::XmlMarkup.new
         attrs = {:Id=>id.to_s}

data/lib/rews/update.rb

@@ -0,0 +1,46 @@
+module Rews
+  class Update
+    attr_reader :field_uri
+    attr_reader :item_expr
+
+    def initialize(field_uri, item_expr=nil)
+      @field_uri = field_uri
+      @item_expr = item_expr
+    end
+
+    def inspect
+      "#<#{Xml.update_tag(self.class)} @field_uri=#{@field_uri}, @item_expr=#{@item_expr.inspect}>"
+    end
+
+    def to_xml
+      Xml.write_update(self.class, field_uri, item_expr)
+    end
+
+    module Xml
+      module_function
+      
+      def write_update(type, field_uri, item_expr)
+        xml = Builder::XmlMarkup.new
+        xml.t(update_tag(type)) do
+          xml.t :FieldURI, :FieldURI=>field_uri
+          xml << Util.rsxml_to_xml(item_expr)
+        end
+        xml.target!
+      end
+
+      def update_tag(type)
+        # final component of module scoped classname
+        type.to_s[/(?:^|::)([^:]+)$/, 1].to_sym
+      end
+    end
+  end
+
+  class SetItemField < Update
+  end
+
+  class AppendToItemField < Update
+  end
+
+  class DeleteItemField < Update
+  end
+end