exchanger 0.1.0

data/lib/exchanger/elements/im_address.rb

@@ -0,0 +1,20 @@
+module Exchanger
+  # The Entry element represents an instant messaging (IM) address for a contact.
+  #
+  # http://msdn.microsoft.com/en-us/library/aa566142.aspx
+  class ImAddress < Entry
+    self.field_uri_namespace = :"contacts:ImAddress"
+
+    element :title
+    element :first_name
+    element :middle_name
+    element :last_name
+    element :suffix
+    element :initials
+    element :full_name
+    element :nickname
+
+    # A text value that represents the entry is required if this element is used.
+    element :text
+  end
+end

data/lib/exchanger/elements/item.rb

@@ -0,0 +1,86 @@
+module Exchanger
+  class Item < Element
+    self.field_uri_namespace = :item
+    self.identifier_name = :item_id
+
+    element :mime_content
+    element :item_id, :type => Identifier
+    element :parent_folder_id, :type => Identifier
+    element :item_class
+    element :subject
+    element :sensitivity
+    element :body
+    element :attachments, :type => [String]
+    element :date_time_received, :type => Time
+    element :size, :type => Integer
+    element :categories, :type => [String]
+    element :importance
+    element :in_reply_to
+    element :is_submitted, :type => Boolean
+    element :is_draft, :type => Boolean
+    element :is_from_me, :type => Boolean
+    element :is_resend, :type => Boolean
+    element :is_unmodified, :type => Boolean
+    element :internet_message_headers, :type => [String]
+    element :date_time_sent, :type => Time
+    element :date_time_created, :type => Time
+    element :response_objects, :type => [String]
+    element :reminder_due_by, :type => Time
+    element :reminder_is_set, :type => Boolean
+    element :reminder_minutes_before_start
+    element :display_cc
+    element :display_to
+    element :has_attachments, :type => Boolean
+    element :extended_property
+    element :culture
+    element :effective_rights
+    element :last_modified_name
+    element :last_modified_time, :type => Time
+
+    def self.find(id)
+      find_all([id]).first
+    end
+
+    def self.find_all(ids)
+      response = GetItem.run(:item_ids => ids)
+      response.items
+    end
+
+    def self.find_all_by_folder_id(folder_id, email_address = nil)
+      response = FindItem.run(:folder_id => folder_id, :email_address => email_address)
+      response.items
+    end
+
+    attr_writer :parent_folder
+
+    def parent_folder
+      @parent_folder ||= if parent_folder_id
+        Folder.find(parent_folder_id.id)
+      end
+    end
+
+    private
+
+    def create
+      if parent_folder_id
+        response = CreateItem.run(:folder_id => parent_folder_id.id, :items => [self])
+        self.item_id = response.item_ids[0]
+        move_changes
+        true
+      else
+        errors << "Parent folder can't be blank"
+        false
+      end
+    end
+
+    def update
+      if changed?
+        response = UpdateItem.run(:items => [self])
+        move_changes
+        true
+      else
+        true
+      end
+    end
+  end
+end

data/lib/exchanger/elements/mailbox.rb

@@ -0,0 +1,34 @@
+module Exchanger
+  # TODO It looks like this is the same as Address.
+  #
+  # The Mailbox element identifies a mail-enabled Active Directory object.
+  #
+  # The EmailAddress and ItemId elements identify a mailbox or distribution list.
+  # The EmailAddress element identifies a mailbox or distribution list by SMTP address.
+  # The ItemId element identifies a mailbox by an item identifier, which is associated with a particular mailbox.
+  # The ItemId element cannot be used for sending a message to a distribution list or a contact in a public contacts folder.
+  # An error will be thrown if this is used in a CreateItem, UpdateItem, or SendItem operation
+  # when an attempt is made to send a message to a distribution list or contact in a contacts public folder.
+  # Use the ExpandDL operation to get the SMTP address and then send the message by
+  # using the EmailAddress element instead of the ItemId element.
+  #
+  # http://msdn.microsoft.com/en-us/library/aa565036.aspx
+  class Mailbox < Element
+    element :name
+    element :email_address
+    element :routing_type
+    element :mailbox_type # Mailbox, PublicDL, PrivateDL, Contact, PublicFolder
+    element :item_id, :type => Identifier
+
+    def self.search(name)
+      response = Exchanger::ResolveNames.run(:name => name)
+      response.mailboxes
+    end
+
+    def members
+      return [] unless mailbox_type == "PublicDL"
+      response = Exchanger::ExpandDL.run(:mailbox => self)
+      response.mailboxes
+    end
+  end
+end

data/lib/exchanger/elements/meeting_cancellation.rb

@@ -0,0 +1,4 @@
+module Exchanger
+  class MeetingCancellation < MeetingMessage
+  end
+end

data/lib/exchanger/elements/meeting_message.rb

@@ -0,0 +1,16 @@
+module Exchanger
+  class MeetingMessage < Item
+    self.field_uri_namespace = :meeting
+
+    element :associated_calendar_item_id, :type => Identifier
+    element :is_delegated, :type => Boolean
+    element :is_out_of_date, :type => Boolean
+    element :has_been_processed, :type => Boolean
+    # Meeting response related properties
+    element :response_type # Unknown, Organizer, Tentative, Accept, Decline, NoResponseReceived
+    # iCalendar properties
+    element :uid, :name => "UID"
+    element :recurrence_id, :type => Time
+    element :date_time_stamp, :type => Time
+  end
+end

data/lib/exchanger/elements/meeting_request.rb

@@ -0,0 +1,6 @@
+module Exchanger
+  # TODO Almost the same as calendar item
+  class MeetingRequest < MeetingMessage
+    self.field_uri_namespace = :meeting_request
+  end
+end

data/lib/exchanger/elements/meeting_response.rb

@@ -0,0 +1,4 @@
+module Exchanger
+  class MeetingResponse < MeetingMessage
+  end
+end

data/lib/exchanger/elements/message.rb

@@ -0,0 +1,24 @@
+module Exchanger
+  # The Message element represents a Microsoft Exchanger e-mail message.
+  #
+  # http://msdn.microsoft.com/en-us/library/aa494306.aspx
+  class Message < Item
+    self.field_uri_namespace = :message
+    element :sender, :type => SingleRecipient
+    element :to_recipients, :type => [Mailbox]
+    element :cc_recipients, :type => [Mailbox]
+    element :bcc_recipients, :type => [Mailbox]
+    element :is_read_receipt_requested, :type => Boolean
+    element :is_delivery_receipt_requested, :type => Boolean
+    element :conversation_index # base64Binary
+    element :conversation_topic
+    element :from, :type => SingleRecipient
+    element :internet_message_id
+    element :is_read, :type => Boolean
+    element :is_response_requested, :type => Boolean
+    element :references
+    element :reply_to, :type => [Mailbox]
+    element :received_by, :type => SingleRecipient
+    element :received_representing, :type => SingleRecipient
+  end
+end

data/lib/exchanger/elements/phone_number.rb

@@ -0,0 +1,13 @@
+module Exchanger
+  # The Entry element represents a telephone number for a contact.
+  # 
+  # http://msdn.microsoft.com/en-us/library/aa565941.aspx
+  class PhoneNumber < Entry
+    self.field_uri_namespace = :"contacts:PhoneNumber"
+
+    key :key # BusinessFax, BusinessPhone, BusinessPhone2, MobilePhone ...
+
+    # A text value that represents the entry is required if this element is used.
+    element :text
+  end
+end

data/lib/exchanger/elements/physical_address.rb

@@ -0,0 +1,15 @@
+module Exchanger
+  # The Entry element describes a single physical address for a contact item.
+  # http://msdn.microsoft.com/en-us/library/aa564323.aspx
+  class PhysicalAddress < Entry
+    self.field_uri_namespace = :"contacts:PhysicalAddress"
+
+    key :key # Business, Home, Other
+
+    element :street
+    element :city
+    element :state
+    element :country_or_region
+    element :postal_code
+  end
+end

data/lib/exchanger/elements/search_folder.rb

@@ -0,0 +1,5 @@
+module Exchanger
+  class SearchFolder < BaseFolder
+    element :search_parameters
+  end
+end

data/lib/exchanger/elements/single_recipient.rb

@@ -0,0 +1,6 @@
+module Exchanger
+  # Organizer, Sender, From, etc
+  class SingleRecipient < Element
+    element :mailbox, :type => Mailbox
+  end
+end

data/lib/exchanger/elements/task.rb

@@ -0,0 +1,5 @@
+module Exchanger
+  class Task < Item
+    self.field_uri_namespace = :task
+  end
+end

data/lib/exchanger/elements/tasks_folder.rb

@@ -0,0 +1,4 @@
+module Exchanger
+  class TasksFolder < BaseFolder
+  end
+end

data/lib/exchanger/field.rb

@@ -0,0 +1,139 @@
+module Exchanger
+  class Field
+    attr_accessor :name, :options
+
+    def initialize(name, options = {})
+      @name = name
+      @options = options
+    end
+
+    def type
+      options[:type] || String
+    end
+
+    def tag_name
+      (options[:name] || name).to_s.camelize
+    end
+
+    # Only for arrays
+    def sub_field
+      if type.is_a?(Array)
+        Field.new(name, {
+          :type => type[0],
+          :field_uri_namespace => field_uri
+        })
+      end
+    end
+
+    def field_uri_namespace
+      options[:field_uri_namespace].to_s
+    end
+
+    def field_uri
+      if name == :text
+        field_uri_namespace
+      else
+        "#{field_uri_namespace}:#{tag_name}"
+      end
+    end
+
+    # FieldURI or IndexedFieldURI
+    # <t:FieldURI FieldURI="item:Sensitivity"/>
+    # <t:IndexedFieldURI FieldURI="contacts:EmailAddress" FieldIndex="EmailAddress1"/>
+    # 
+    # http://msdn.microsoft.com/en-us/library/aa494315.aspx
+    # http://msdn.microsoft.com/en-us/library/aa581079.aspx
+    def to_xml_field_uri(value)
+      doc = Nokogiri::XML::Document.new
+      if value.is_a?(Entry)
+        doc.create_element("IndexedFieldURI", "FieldURI" => field_uri, "FieldIndex" => value.key)
+      else
+        doc.create_element("FieldURI", "FieldURI" => field_uri)
+      end
+    end
+
+    # See Element#to_xml_updates.
+    # Yields blocks with FieldURI and Item/Folder/etc changes.
+    def to_xml_updates(value)
+      return if options[:readonly]
+      doc = Nokogiri::XML::Document.new
+      if value.is_a?(Array)
+        value.each do |sub_value|
+          sub_field.to_xml_updates(sub_value) do |field_uri_xml, element_xml|
+            element_wrapper = doc.create_element(sub_field.tag_name)
+            element_wrapper << element_xml
+            yield [
+              field_uri_xml,
+              element_wrapper
+            ]
+          end
+        end
+      elsif value.is_a?(Exchanger::Element)
+        value.tag_name = tag_name
+        if value.class.elements.keys.include?(:text)
+          field = value.class.elements[:text]
+          yield [
+            field.to_xml_field_uri(value),
+            field.to_xml(value)
+          ]
+        else
+          # PhysicalAddress ?
+          value.class.elements.each do |name, field|
+            yield [
+              field.to_xml_field_uri(value),
+              field.to_xml(value, :only => [name])
+            ]
+          end
+        end
+      else # String, Integer, Boolean, ...
+        yield [
+          self.to_xml_field_uri(value),
+          self.to_xml(value)
+        ]
+      end
+    end
+
+    # Convert Ruby value to XML
+    def to_xml(value, options = {})
+      if value.is_a?(Exchanger::Element)
+        value.tag_name = tag_name
+        value.to_xml(options)
+      else
+        doc = Nokogiri::XML::Document.new
+        root = doc.create_element(tag_name)
+        case value
+        when Array
+          value.each do |sub_value|
+            root << sub_field.to_xml(sub_value, options)
+          end
+        when Boolean
+          root << doc.create_text_node(value == true)
+        when Time
+          root << doc.create_text_node(value.xmlschema)
+        else # String, Integer, etc
+          root << doc.create_text_node(value.to_s)
+        end
+        root
+      end
+    end
+
+    # Convert XML to Ruby value
+    def value_from_xml(node)
+      if type.respond_to?(:new_from_xml)
+        type.new_from_xml(node)
+      elsif type.is_a?(Array)
+        node.children.map do |sub_node|
+          sub_field.value_from_xml(sub_node)
+        end
+      elsif type == Boolean
+        node.text == "true"
+      elsif type == Integer
+        node.text.to_i unless node.text.empty?
+      elsif type == Time
+        Time.xmlschema(node.text) unless node.text.empty?
+      else
+        node.text
+      end
+    end
+  end
+end

data/lib/exchanger/operation.rb

@@ -0,0 +1,110 @@
+module Exchanger
+  # Abstract class for operations.
+  #
+  # Exchanger Web Services provides many operations that enable you to access
+  # information from the Exchanger store.
+  # 
+  # http://msdn.microsoft.com/en-us/library/bb409286.aspx
+  class Operation
+    attr_reader :options, :request, :response
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    # Shortcut for initialize and run.
+    def self.run(options = {})
+      operation = self.new(options)
+      operation.run
+    end
+
+    # Returns response
+    def run
+      @request = self.class::Request.new(options)
+      @response = self.class::Response.new(
+        Exchanger::Client.new.request(@request.body, @request.headers)
+      )
+    end
+
+    class Request
+      attr_accessor :body, :response
+
+      def initialize(options = {})
+        reset
+        options.each do |name, value|
+          send("#{name}=", value) if respond_to?("#{name}=")
+        end
+      end
+
+      def reset
+      end
+
+      # For a request with class Exchanger::FindItem::Request it will return "FindItem".
+      def action
+        self.class.name.split("::")[1]
+      end
+
+      def headers
+        { "SOAPAction" => "http://schemas.microsoft.com/exchange/services/2006/messages/#{action}",
+          "Content-Type" => "text/xml; charset=utf-8" }
+      end
+
+      def body
+        to_xml.to_xml
+      end
+
+      def to_xml
+        raise "NotImplemented"
+      end
+    end
+
+    class ResponseError < StandardError
+      attr_reader :response_code
+
+      def initialize(message, response_code)
+        super message
+        @response_code = response_code
+      end
+    end
+
+    class Response
+      attr_reader :status, :body
+
+      def initialize(options = {})
+        @status = options[:status]
+        @body   = options[:body]
+        parse_soap_errors
+        parse_response_message
+      end
+
+      def to_xml
+        @xml ||= Nokogiri::XML(@body)
+      end
+
+      def parse_soap_errors
+        fault_node = to_xml.xpath(".//faultstring")
+        unless fault_node.empty?
+          error_msg = fault_node.text
+          raise ResponseError.new(error_msg, 0)
+        end
+      end
+
+      # Checks the ResponseMessage for errors.
+      #
+      # http://msdn.microsoft.com/en-us/library/aa494164%28EXCHG.80%29.aspx
+      # Exhange 2007 Valid Response Messages
+      def parse_response_message
+        error_node = to_xml.xpath('//m:ResponseMessages/child::*[@ResponseClass="Error"]', NS)
+        unless error_node.empty?
+          error_msg = error_node.xpath('m:MessageText/text()', NS).to_s
+          response_code = error_node.xpath('m:ResponseCode/text()', NS).to_s
+          raise ResponseError.new(error_msg, response_code)
+        end
+      end
+
+      def code
+        raise NotImplemented
+      end
+    end
+  end
+end