exchanger 0.1.0

data/lib/exchanger/element.rb

@@ -0,0 +1,161 @@
+module Exchanger
+  # General purpose element.
+  class Element
+    include Exchanger::Attributes
+    include Exchanger::Dirty
+    include Exchanger::Persistence
+
+    class_inheritable_accessor :elements
+    class_inheritable_accessor :keys
+    class_inheritable_accessor :field_uri_namespace
+    class_inheritable_accessor :identifier_name
+
+    # Exchanger expects elements to be in the same order as defined in types.xsd
+    self.elements = ActiveSupport::OrderedHash.new
+    self.keys = []
+
+    # Define a new child element.
+    def self.element(name, options = {})
+      options[:field_uri_namespace] ||= self.field_uri_namespace
+      elements[name] = Field.new(name, options)
+      create_element_accessors(name)
+      add_dirty_methods(name)
+    end
+
+    # Defina a new element attribute.
+    def self.key(name, options = {})
+      keys << name
+      create_element_accessors(name)
+      add_dirty_methods(name)
+    end
+
+    # Create child element accessors.
+    def self.create_element_accessors(name)
+      define_method(name) { read_attribute(name) }
+      define_method("#{name}=") { |value| write_attribute(name, value) }
+      define_method("#{name}?") { read_attribute(name).present? }
+    end
+
+    attr_writer :tag_name
+
+    def tag_name
+      @tag_name || self.class.name.demodulize
+    end
+
+    def initialize(attributes = {})
+      @attributes = {}
+      self.attributes = attributes
+      setup_modifications
+    end
+
+    # Performs equality checking on attributes
+    def ==(other)
+      self.class == other.class &&
+      self.attributes == other.attributes
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def inspect
+      keys = self.class.elements.keys | attributes.keys.map(&:to_sym)
+      keys -= [:id, :change_key, self.class.identifier_name]
+      attrs = keys.map { |name, field| "#{name}: #{attributes[name.to_s].inspect}" }
+      str = "#<#{self.class.name}"
+      str << " id: #{id.inspect}, change_key: #{change_key.inspect}" if self.class.identifier_name || self.class.keys.include?(:id)
+      str << " #{attrs * ', '}" unless attrs.empty?
+      str << ">"
+      str
+    end
+
+    def self.new_from_xml(xml)
+      object = new
+      # Keys
+      xml.attributes.values.each do |attr|
+        name = attr.name.underscore.to_sym
+        value = attr.value
+        object.write_attribute(name, value)
+      end
+      # Fields
+      xml.children.each do |node|
+        name = node.name.underscore.to_sym
+        field = elements[name] || Field.new(name)
+        value = field.value_from_xml(node)
+        object.write_attribute(name, value)
+      end
+      object.send(:reset_modifications)
+      object
+    end
+
+    # Builds XML from elements and attributes
+    def to_xml(options = {})
+      doc = Nokogiri::XML::Document.new
+      root = doc.create_element(tag_name)
+      self.class.keys.each do |name|
+        value = read_attribute(name)
+        next if value.blank?
+        root[name.to_s.camelize] = value
+      end
+      self.class.elements.each do |name, field|
+        next if options[:only] && !options[:only].include?(name)
+        next if field.options[:readonly]
+        value = read_attribute(name)
+        next if field.type.is_a?(Array) && value.blank?
+        next if new_record? && field.type == Identifier
+        next if new_record? && value.blank?
+        if name == :text
+          root << value.to_s
+        else
+          root << field.to_xml(value)
+        end
+      end
+      root
+    end
+
+    # Builds XML Item/Folder change for update operations.
+    def to_xml_change
+      doc = Nokogiri::XML::Document.new
+      root = doc.create_element("#{identifier.tag_name.gsub(/Id$/, '')}Change")
+      root << identifier.to_xml
+      root << to_xml_updates
+      root
+    end
+
+    # Builds XML Set/Delete fields for update operations.
+    def to_xml_updates
+      doc = Nokogiri::XML::Document.new
+      root = doc.create_element("Updates")
+      self.class.elements.each do |name, field|
+        value = read_attribute(name)
+        # Create or update existing fields
+        if changes.include?(name.to_s)
+          field.to_xml_updates(value) do |field_uri_xml, element_xml|
+            # Exchanger does not like updating to nil, so delete those.
+            if element_xml.text.present?
+              set_item_field = doc.create_element("SetItemField")
+              set_item_field << field_uri_xml
+              set_item_field << doc.create_element(tag_name) << element_xml
+              root << set_item_field
+            else
+              delete_item_field = doc.create_element("DeleteItemField")
+              delete_item_field << field_uri_xml
+              root << delete_item_field
+            end
+          end
+        end
+        # Delete removed phone numbers, etc
+        if changes.include?(name.to_s) && value.is_a?(Array)
+          old_values, new_values = changes[name.to_s]
+          deleted_values = old_values - new_values
+          field.to_xml_updates(deleted_values) do |field_uri_xml, _|
+            delete_item_field = doc.create_element("DeleteItemField")
+            delete_item_field << field_uri_xml
+            root << delete_item_field
+          end
+        end
+      end
+      root
+    end
+  end
+end

data/lib/exchanger/elements/attendee.rb

@@ -0,0 +1,10 @@
+module Exchanger
+  # The Attendee element represents attendees and resources for a meeting.
+  #
+  # http://msdn.microsoft.com/en-us/library/aa580339.aspx
+  class Attendee < Element
+    element :mailbox, :type => Mailbox
+    element :response_type # Unknown Organizer Tentative Accept Decline NoResponseReceived
+    element :last_response_time, :type => Time
+  end
+end

data/lib/exchanger/elements/base_folder.rb

@@ -0,0 +1,61 @@
+module Exchanger
+  # Abstract folder class
+  class BaseFolder < Element
+    self.identifier_name = :folder_id
+    self.field_uri_namespace = :folder
+
+    element :folder_id, :type => Identifier
+    element :parent_folder_id, :type => Identifier
+    element :folder_class
+    element :display_name
+    element :total_count, :type => Integer
+    element :child_folder_count, :type => Integer
+    element :extended_property, :type => Element
+    element :managed_folder_information, :type => Element
+    element :effective_rights, :type => Element
+
+    # Folders that can be referenced by name.
+    # http://msdn.microsoft.com/en-us/library/aa580808.aspx
+    DISTINGUISHED_NAMES = [
+      :inbox, :outbox, :drafts, :deleteditems, :sentitems, :junkemail,
+      :calendar, :contacts, :tasks, :notes, :journal,
+      :msgfolderroot, :publicfoldersroot, :root,
+      :searchfolders, :voicemail
+    ]
+
+    def self.find(id, email_address = nil)
+      find_all([id], email_address).first
+    end
+
+    def self.find_all(ids, email_address = nil)
+      response = GetFolder.run(:folder_ids => ids, :email_address => email_address)
+      response.folders
+    end
+
+    def self.find_all_by_parent_id(parent_id)
+      response = FindFolder.run(:parent_folder_id => parent_id)
+      response.folders
+    end
+
+    attr_writer :parent_folder
+
+    def parent_folder
+      @parent_folder ||= if parent_folder_id
+        Folder.find(parent_folder_id.id)
+      end
+    end
+
+    # Sub folders
+    def folders
+      self.class.find_all_by_parent_id(id).each do |folder|
+        folder.parent_folder = self
+      end
+    end
+
+    def items
+      Item.find_all_by_folder_id(id).each do |item|
+        item.parent_folder = self
+      end
+    end
+  end
+end

data/lib/exchanger/elements/calendar_folder.rb

@@ -0,0 +1,11 @@
+module Exchanger
+  class CalendarFolder < BaseFolder
+    element :permission_set
+
+    def new_calendar_item(attributes = {})
+      contact = CalendarItem.new(attributes)
+      contact.parent_folder_id = folder_id
+      contact
+    end
+  end
+end

data/lib/exchanger/elements/calendar_item.rb

@@ -0,0 +1,59 @@
+module Exchanger
+  # The CalendarItem element represents an Exchanger calendar item.
+  # 
+  # http://msdn.microsoft.com/en-us/library/aa564765.aspx
+  class CalendarItem < Item
+    self.field_uri_namespace = :calendar
+
+    # iCalendar properties
+    element :uid, :name => "UID"
+    element :recurrence_id, :type => Time
+    element :date_time_stamp, :type => Time
+    # Single and Occurrence only
+    element :start, :type => Time
+    element :end, :type => Time
+    # Occurrence only
+    element :original_start, :type => Time
+    # Other properties
+    element :is_all_day_event, :type => Boolean
+    element :legacy_free_busy_status
+    element :location
+    element :when
+    element :is_meeting, :type => Boolean
+    element :is_cancelled, :type => Boolean
+    element :is_recurring, :type => Boolean
+    element :meeting_request_was_sent, :type => Boolean
+    element :is_response_requested, :type => Boolean
+    element :calendar_item_type
+    element :my_response_type
+    element :organizer, :type => SingleRecipient
+    element :required_attendees, :type => [Attendee]
+    element :optional_attendees, :type => [Attendee]
+    element :resources, :type => [Attendee]
+    # Conflicting and adjacent meetings
+    element :conflicting_meeting_count, :type => Integer
+    element :adjacent_meeting_count, :type => Integer
+    element :conflicting_meetings, :type => [CalendarItem]
+    element :adjacent_meetings, :type => [CalendarItem]
+    # Duration
+    element :duration
+    element :time_zone
+    # Appointment
+    element :appointment_reply_time, :type => Time
+    element :appointment_sequence_number, :type => Integer
+    element :appointment_state, :type => Integer
+    # Recurrence specific data, only valid if CalendarItemType is RecurringMaster
+    element :recurrence #, :type => Recurrence
+    element :first_occurrence #, :type => OccurrenceInfo
+    element :last_occurrence #, :type => OccurrenceInfo
+    element :modified_occurrences #, :type => [OccurrenceInfo]
+    element :deleted_occurrences #, :type => [DeletedOccurrenceInfo]
+    element :meeting_time_zone #, :type => TimeZone
+    # Other properties
+    element :conference_type, :type => Integer
+    element :allow_new_time_proposal, :type => Boolean
+    element :is_online_meeting, :type => Boolean
+    element :meeting_workspace_url
+    element :net_show_url
+  end
+end

data/lib/exchanger/elements/complete_name.rb

@@ -0,0 +1,16 @@
+module Exchanger
+  # The CompleteName element represents the complete name of a contact.
+  # This element is read only and will not be sent on create/update.
+  # 
+  # http://msdn.microsoft.com/en-us/library/aa494294.aspx
+  class CompleteName < Element
+    element :title
+    element :first_name
+    element :middle_name
+    element :last_name
+    element :suffix
+    element :initials
+    element :full_name
+    element :nickname
+  end
+end

data/lib/exchanger/elements/contact.rb

@@ -0,0 +1,49 @@
+module Exchanger
+  # The Contact element represents a contact item in the Exchanger store.
+  # http://msdn.microsoft.com/en-us/library/aa581315.aspx
+  class Contact < Item
+    # All the uri namespaces are singular (item, task, etc) except contacts.
+    self.field_uri_namespace = :contacts
+
+    element :file_as
+    element :file_as_mapping
+    element :display_name
+    element :given_name
+    element :initials
+    element :middle_name
+    element :nickname
+    element :complete_name, :type => CompleteName, :readonly => true
+    element :company_name
+    element :email_addresses, :type => [EmailAddress]
+    element :physical_addresses, :type => [PhysicalAddress]
+    element :phone_numbers, :type => [PhoneNumber]
+    element :assistant_name
+    element :birthday, :type => Time
+    element :business_home_page
+    element :children, :type => [String]
+    element :companies, :type => [String]
+    element :contact_source # ActiveDirectory, Store
+    element :department
+    element :generation
+    element :im_addresses, :type => [ImAddress]
+    element :job_title
+    element :manager
+    element :mileage
+    element :office_location
+    element :postal_address_index
+    element :profession
+    element :spouse_name
+    element :surname
+    element :wedding_anniversary, :type => Time
+
+    # Marked as private in Outlook?
+    def private?
+      sensitivity == "Private"
+    end
+
+    def self.search(name)
+      response = Exchanger::ResolveNames.run(:name => name)
+      response.contacts
+    end
+  end
+end

data/lib/exchanger/elements/contacts_folder.rb

@@ -0,0 +1,17 @@
+module Exchanger
+  class ContactsFolder < BaseFolder
+    element :permission_set
+
+    def contacts
+      items.select do |item|
+        item.is_a?(Contact)
+      end
+    end
+
+    def new_contact(attributes = {})
+      contact = Contact.new(attributes)
+      contact.parent_folder_id = folder_id
+      contact
+    end
+  end
+end

data/lib/exchanger/elements/distribution_list.rb

@@ -0,0 +1,8 @@
+module Exchanger
+  # http://msdn.microsoft.com/en-us/library/aa566353.aspx
+  class DistributionList < Item
+    element :display_name
+    element :file_as
+    element :contact_source # ActiveDirectory, Store
+  end
+end

data/lib/exchanger/elements/email_address.rb

@@ -0,0 +1,16 @@
+module Exchanger
+  # The Entry element represents a single e-mail address for a contact.
+  # 
+  # http://msdn.microsoft.com/en-us/library/aa564757.aspx
+  class EmailAddress < Entry
+    self.field_uri_namespace = :"contacts:EmailAddress"
+
+    key :key # EmailAddress1, EmailAddress2 or EmailAddress3
+    key :name
+    key :routing_type
+    key :mailbox_type
+
+    # A text value that represents the entry is required if this element is used.
+    element :text
+  end
+end

data/lib/exchanger/elements/entry.rb

@@ -0,0 +1,11 @@
+module Exchanger
+  # Entry (EmailAddress), 
+  # Entry (IMAddress), 
+  # Entry (PhoneNumber), 
+  # Entry (PhysicalAddress)
+  class Entry < Element
+    def tag_name
+      "Entry"
+    end
+  end
+end

data/lib/exchanger/elements/folder.rb

@@ -0,0 +1,9 @@
+module Exchanger
+  # The Folder element defines a folder to create, get, find, synchronize, or update.
+  # 
+  # http://msdn.microsoft.com/en-us/library/aa494294.aspx
+  class Folder < BaseFolder
+    element :permission_set
+    element :unread_count, :type => Integer
+  end
+end

data/lib/exchanger/elements/identifier.rb

@@ -0,0 +1,7 @@
+module Exchanger
+  # ItemId, FolderId, etc
+  class Identifier < Element
+    key :id
+    key :change_key
+  end
+end