viewpoint 1.2.0 → 2.0.0

data/lib/ews/templates/calendar_item.rb

@@ -1,79 +1,83 @@
-module Viewpoint::EWS
-  module Template
-  # Template for creating CalendarItems
-  # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
-  class CalendarItem < OpenStruct
+# frozen_string_literal: true
 
-      # Available parameters with the required ordering
-      PARAMETERS = %w{mime_content item_id parent_folder_id item_class subject sensitivity body attachments
-        date_time_received size categories in_reply_to is_submitted is_draft is_from_me is_resend is_unmodified
-        internet_message_headers date_time_sent date_time_created response_objects reminder_due_by reminder_is_set
-        reminder_minutes_before_start display_cc display_to has_attachments extended_property culture start end
-        original_start is_all_day_event legacy_free_busy_status location when is_meeting is_cancelled is_recurring
-        meeting_request_was_sent is_response_requested calendar_item_type my_response_type organizer
-        required_attendees optional_attendees resources conflicting_meeting_count adjacent_meeting_count
-        conflicting_meetings adjacent_meetings duration time_zone appointment_reply_time appointment_sequence_number
-        appointment_state recurrence first_occurrence last_occurrence modified_occurrences deleted_occurrences
-        meeting_time_zone start_time_zone end_time_zone conference_type allow_new_time_proposal is_online_meeting
-        meeting_workspace_url net_show_url effective_rights last_modified_name last_modified_time is_associated
-        web_client_read_form_query_string web_client_edit_form_query_string conversation_id unique_body
-      }.map(&:to_sym).freeze
+module Viewpoint
+  module EWS
+    module Template
+      # Template for creating CalendarItems
+      # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
+      class CalendarItem < OpenStruct
+        # Available parameters with the required ordering
+        PARAMETERS = %w[mime_content item_id parent_folder_id item_class subject sensitivity body attachments
+                        date_time_received size categories in_reply_to is_submitted is_draft is_from_me
+                        is_resend is_unmodified internet_message_headers date_time_sent date_time_created
+                        response_objects reminder_due_by reminder_is_set reminder_minutes_before_start
+                        display_cc display_to has_attachments extended_property culture start end original_start
+                        is_all_day_event legacy_free_busy_status location when is_meeting is_cancelled
+                        is_recurring meeting_request_was_sent is_response_requested calendar_item_type
+                        my_response_type organizer required_attendees optional_attendees resources
+                        conflicting_meeting_count adjacent_meeting_count conflicting_meetings adjacent_meetings
+                        duration time_zone appointment_reply_time appointment_sequence_number appointment_state
+                        recurrence first_occurrence last_occurrence modified_occurrences deleted_occurrences
+                        meeting_time_zone start_time_zone end_time_zone conference_type allow_new_time_proposal
+                        is_online_meeting meeting_workspace_url net_show_url effective_rights last_modified_name
+                        last_modified_time is_associated web_client_read_form_query_string
+                        web_client_edit_form_query_string conversation_id unique_body].map(&:to_sym).freeze
 
-      # Returns a new CalendarItem template
-      def initialize(opts = {})
-        super opts.dup
-      end
+        # Returns a new CalendarItem template
+        def initialize(opts = {})
+          super opts.dup
+        end
 
-      # EWS CreateItem container
-      # @return [Hash]
-      def to_ews_create(opts = {})
-        structure = {}
-        structure[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
-        # options
-        structure[:send_meeting_invitations] = (opts.has_key?(:send_meeting_invitations) ? opts[:send_meeting_invitations] : 'SendToNone')
+        # EWS CreateItem container
+        # @return [Hash]
+        def to_ews_create(opts = {})
+          structure = {}
+          structure[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
+          # options
+          structure[:send_meeting_invitations] =
+            (opts.key?(:send_meeting_invitations) ? opts[:send_meeting_invitations] : 'SendToNone')
 
-        if self.saved_item_folder_id
-          if self.saved_item_folder_id.kind_of?(Hash)
-            structure[:saved_item_folder_id] = saved_item_folder_id
-          else
-            structure[:saved_item_folder_id] = {id: saved_item_folder_id}
+          if saved_item_folder_id
+            structure[:saved_item_folder_id] = if saved_item_folder_id.is_a?(Hash)
+                                                 saved_item_folder_id
+                                               else
+                                                 { id: saved_item_folder_id }
+                                               end
           end
-        end
 
-        structure[:items] = [{calendar_item: to_ews_item}]
-        structure
-      end
+          structure[:items] = [{ calendar_item: to_ews_item }]
+          structure
+        end
 
-      # EWS Item hash
-      #
-      # Puts all known parameters in the required ordering and structure
-      # @return [Hash]
-      def to_ews_item
-        item_parameters = {}
-        PARAMETERS.each do |key|
-          if !(value = self.send(key)).nil?
+        # EWS Item hash
+        #
+        # Puts all known parameters in the required ordering and structure
+        # @return [Hash]
+        def to_ews_item
+          item_parameters = {}
+          PARAMETERS.each do |key|
+            next if (value = send(key)).nil?
 
             # Convert non duplicable values to String
             case value
-              when NilClass, FalseClass, TrueClass, Symbol, Numeric
-                value = value.to_s
+            when NilClass, FalseClass, TrueClass, Symbol, Numeric
+              value = value.to_s
             end
 
             # Convert attributes
-            case key
-              when :start, :end
-                item_parameters[key] = {text: value.respond_to?(:iso8601) ? value.iso8601 : value}
-              when :body
-                item_parameters[key] = {body_type: self.body_type || 'Text', text: value.to_s}
-              else
-                item_parameters[key] = value
-            end
+            item_parameters[key] = case key
+                                   when :start, :end
+                                     { text: value.respond_to?(:iso8601) ? value.iso8601 : value }
+                                   when :body
+                                     { body_type: body_type || 'Text', text: value.to_s }
+                                   else
+                                     value
+                                   end
           end
-        end
 
-        item_parameters
+          item_parameters
+        end
       end
-
     end
   end
 end

data/lib/ews/templates/forward_item.rb

@@ -1,24 +1,26 @@
-module Viewpoint::EWS
-  module Template
-    class ForwardItem < Message
+# frozen_string_literal: true
 
-      # Format this object for EWS backend consumption.
-      def to_ews
-        ews_opts, msg = to_ews_basic
-        msg[:reference_item_id] = reference_item_id
-        msg[:new_body_content]  = {text: new_body_content, body_type: new_body_type}
-        ews_opts.merge({items: [{forward_item: msg}]})
-      end
-
-      private
+module Viewpoint
+  module EWS
+    module Template
+      # Template for building forward-item requests.
+      class ForwardItem < Message
+        # Format this object for EWS backend consumption.
+        def to_ews
+          ews_opts, msg = to_ews_basic
+          msg[:reference_item_id] = reference_item_id
+          msg[:new_body_content]  = { text: new_body_content, body_type: new_body_type }
+          ews_opts.merge({ items: [{ forward_item: msg }] })
+        end
 
+        private
 
-      def init_defaults!
-        super
-        self.new_body_content ||= ''
-        self.new_body_type ||= 'Text'
+        def init_defaults!
+          super
+          self.new_body_content ||= ''
+          self.new_body_type ||= 'Text'
+        end
       end
-
     end
   end
 end

data/lib/ews/templates/message.rb

@@ -1,76 +1,79 @@
-module Viewpoint::EWS
-  module Template
-    class Message < OpenStruct
-
-      def initialize(opts = {})
-        super opts.clone
-        init_defaults!
-      end
-
-      # Format this object for EWS backend consumption.
-      def to_ews
-        ews_opts, msg = to_ews_basic
-        ews_opts.merge({items: [{message: msg}]})
-      end
-
-      def has_attachments?
-        !(file_attachments.empty? && item_attachments.empty? && inline_attachments.empty?)
-      end
-
+# frozen_string_literal: true
+
+module Viewpoint
+  module EWS
+    module Template
+      # Template for building message requests.
+      class Message < OpenStruct
+        def initialize(opts = {})
+          super opts.clone
+          init_defaults!
+        end
 
-      private
+        # Format this object for EWS backend consumption.
+        def to_ews
+          ews_opts, msg = to_ews_basic
+          ews_opts.merge({ items: [{ message: msg }] })
+        end
 
+        def has_attachments? # rubocop:disable Naming/PredicatePrefix -- public API name
+          !(file_attachments.empty? && item_attachments.empty? && inline_attachments.empty?)
+        end
 
-      def init_defaults!
-        self.subject ||= nil
-        self.body ||= nil
-        self.body_type ||= 'Text'
-        self.importance ||= 'Normal'
-        self.draft ||= false
-        self.is_read = true if is_read.nil?
-        self.to_recipients ||= []
-        self.cc_recipients ||= []
-        self.bcc_recipients ||= []
-        self.file_attachments ||= []
-        self.item_attachments ||= []
-        self.inline_attachments ||= []
-        self.extended_properties ||= []
-      end
+        private
+
+        def init_defaults!
+          self.subject ||= nil
+          self.body ||= nil
+          self.body_type ||= 'Text'
+          self.importance ||= 'Normal'
+          self.draft ||= false
+          self.is_read = true if is_read.nil?
+          self.to_recipients ||= []
+          self.cc_recipients ||= []
+          self.bcc_recipients ||= []
+          self.file_attachments ||= []
+          self.item_attachments ||= []
+          self.inline_attachments ||= []
+          self.extended_properties ||= []
+          self.mime_content_charset ||= 'UTF-8'
+        end
 
-      def to_ews_basic
-        ews_opts = {}
-        ews_opts[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
+        def to_ews_basic
+          ews_opts = {}
+          ews_opts[:message_disposition] = message_disposition || (draft ? 'SaveOnly' : 'SendAndSaveCopy')
 
-        if saved_item_folder_id
-          if saved_item_folder_id.kind_of?(Hash)
-            ews_opts[:saved_item_folder_id] = saved_item_folder_id
-          else
-            ews_opts[:saved_item_folder_id] = {id: saved_item_folder_id}
+          if saved_item_folder_id
+            ews_opts[:saved_item_folder_id] = if saved_item_folder_id.is_a?(Hash)
+                                                saved_item_folder_id
+                                              else
+                                                { id: saved_item_folder_id }
+                                              end
           end
-        end
 
-        msg = {}
-        msg[:subject] = subject if subject
-        msg[:body] = {text: body, body_type: body_type} if body
+          msg = {}
+          msg[:mime_content] = { text: mime_content, character_set: mime_content_charset } if mime_content
+          msg[:subject] = subject if subject
+          msg[:body] = { text: body, body_type: body_type } if body
 
-        msg[:importance] = importance if importance
+          msg[:importance] = importance if importance
 
-        to_r = to_recipients.collect{|r| {mailbox: {email_address: r}}}
-        msg[:to_recipients] = to_r unless to_r.empty?
+          to_r = to_recipients.collect { |r| { mailbox: { email_address: r } } }
+          msg[:to_recipients] = to_r unless to_r.empty?
 
-        cc_r = cc_recipients.collect{|r| {mailbox: {email_address: r}}}
-        msg[:cc_recipients] = cc_r unless cc_r.empty?
+          cc_r = cc_recipients.collect { |r| { mailbox: { email_address: r } } }
+          msg[:cc_recipients] = cc_r unless cc_r.empty?
 
-        bcc_r = bcc_recipients.collect{|r| {mailbox: {email_address: r}}}
-        msg[:bcc_recipients] = bcc_r unless bcc_r.empty?
+          bcc_r = bcc_recipients.collect { |r| { mailbox: { email_address: r } } }
+          msg[:bcc_recipients] = bcc_r unless bcc_r.empty?
 
-        msg[:is_read] = is_read
+          msg[:is_read] = is_read
 
-        msg[:extended_properties] = extended_properties unless extended_properties.empty?
+          msg[:extended_properties] = extended_properties unless extended_properties.empty?
 
-        [ews_opts, msg]
+          [ews_opts, msg]
+        end
       end
-
     end
   end
 end

data/lib/ews/templates/reply_to_item.rb

@@ -1,25 +1,27 @@
-module Viewpoint::EWS
-  module Template
-    class ReplyToItem < Message
+# frozen_string_literal: true
 
-      # Format this object for EWS backend consumption.
-      def to_ews
-        ews_opts, msg = to_ews_basic
-        msg[:reference_item_id] = reference_item_id
-        msg[:new_body_content]  = {text: new_body_content, body_type: new_body_type}
-        ews_opts.merge({items: [{ews_type => msg}]})
-      end
-
-      private
+module Viewpoint
+  module EWS
+    module Template
+      # Template for building reply-to-item requests.
+      class ReplyToItem < Message
+        # Format this object for EWS backend consumption.
+        def to_ews
+          ews_opts, msg = to_ews_basic
+          msg[:reference_item_id] = reference_item_id
+          msg[:new_body_content]  = { text: new_body_content, body_type: new_body_type }
+          ews_opts.merge({ items: [{ ews_type => msg }] })
+        end
 
+        private
 
-      def init_defaults!
-        super
-        self.new_body_content ||= ''
-        self.new_body_type ||= 'Text'
-        self.ews_type = :reply_to_item
+        def init_defaults!
+          super
+          self.new_body_content ||= ''
+          self.new_body_type ||= 'Text'
+          self.ews_type = :reply_to_item
+        end
       end
-
     end
   end
 end

data/lib/ews/templates/task.rb

@@ -1,74 +1,74 @@
-module Viewpoint::EWS
-  module Template
-  # Template for creating Tasks
-  # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
-  class Task < OpenStruct
+# frozen_string_literal: true
 
-      # Available parameters with the required ordering
-      PARAMETERS = %w{mime_content item_id parent_folder_id item_class subject sensitivity body attachments
-            date_time_received size categories in_reply_to is_submitted is_draft is_from_me is_resend
-            is_unmodified internet_message_headers date_time_sent date_time_created response_objects
-            reminder_due_by reminder_is_set reminder_minutes_before_start display_cc display_to
-            has_attachments extended_property culture actual_work assigned_time billing_information
-            change_count companies complete_date contacts delegation_state delegator due_date
-            is_assignment_editable is_complete is_recurring is_team_task mileage owner percent_complete
-            recurrence start_date status status_description total_work effective_rights last_modified_name
-            last_modified_time is_associated web_client_read_form_query_string
-            web_client_edit_form_query_string conversation_id unique_body 
-      }.map(&:to_sym).freeze
+module Viewpoint
+  module EWS
+    module Template
+      # Template for creating Tasks
+      # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
+      class Task < OpenStruct
+        # Available parameters with the required ordering
+        PARAMETERS = %w[mime_content item_id parent_folder_id item_class subject sensitivity body attachments
+                        date_time_received size categories in_reply_to is_submitted is_draft is_from_me is_resend
+                        is_unmodified internet_message_headers date_time_sent date_time_created response_objects
+                        reminder_due_by reminder_is_set reminder_minutes_before_start display_cc display_to
+                        has_attachments extended_property culture actual_work assigned_time billing_information
+                        change_count companies complete_date contacts delegation_state delegator due_date
+                        is_assignment_editable is_complete is_recurring is_team_task mileage owner percent_complete
+                        recurrence start_date status status_description total_work effective_rights last_modified_name
+                        last_modified_time is_associated web_client_read_form_query_string
+                        web_client_edit_form_query_string conversation_id unique_body].map(&:to_sym).freeze
 
-      # Returns a new Task template
-      def initialize(opts = {})
-        super opts.dup
-      end
+        # Returns a new Task template
+        def initialize(opts = {})
+          super opts.dup
+        end
 
-      # EWS CreateItem container
-      # @return [Hash]
-      def to_ews_create
-        structure = {}
+        # EWS CreateItem container
+        # @return [Hash]
+        def to_ews_create
+          structure = {}
 
-        if self.saved_item_folder_id
-          if self.saved_item_folder_id.kind_of?(Hash)
-            structure[:saved_item_folder_id] = saved_item_folder_id
-          else
-            structure[:saved_item_folder_id] = {id: saved_item_folder_id}
+          if saved_item_folder_id
+            structure[:saved_item_folder_id] = if saved_item_folder_id.is_a?(Hash)
+                                                 saved_item_folder_id
+                                               else
+                                                 { id: saved_item_folder_id }
+                                               end
           end
-        end
 
-        structure[:items] = [{task: to_ews_item}]
-        structure
-      end
+          structure[:items] = [{ task: to_ews_item }]
+          structure
+        end
 
-      # EWS Item hash
-      #
-      # Puts all known parameters in the required ordering and structure
-      # @return [Hash]
-      def to_ews_item
-        item_parameters = {}
-        PARAMETERS.each do |key|
-          if !(value = self.send(key)).nil?
+        # EWS Item hash
+        #
+        # Puts all known parameters in the required ordering and structure
+        # @return [Hash]
+        def to_ews_item
+          item_parameters = {}
+          PARAMETERS.each do |key|
+            next if (value = send(key)).nil?
 
             # Convert non duplicable values to String
             case value
-              when NilClass, FalseClass, TrueClass, Symbol, Numeric
-                value = value.to_s
+            when NilClass, FalseClass, TrueClass, Symbol, Numeric
+              value = value.to_s
             end
 
             # Convert attributes
-            case key
-              when :start_date, :due_date
-                item_parameters[key] = {text: value.respond_to?(:iso8601) ? value.iso8601 : value}
-              when :body
-                item_parameters[key] = {body_type: self.body_type || 'Text', text: value.to_s}
-              else
-                item_parameters[key] = value
-            end
+            item_parameters[key] = case key
+                                   when :start_date, :due_date
+                                     { text: value.respond_to?(:iso8601) ? value.iso8601 : value }
+                                   when :body
+                                     { body_type: body_type || 'Text', text: value.to_s }
+                                   else
+                                     value
+                                   end
           end
-        end
 
-        item_parameters
+          item_parameters
+        end
       end
-
     end
   end
 end