viewpoint 1.2.0 → 2.0.0

data/lib/ews/soap/parsers/ews_sax_document.rb

@@ -1,70 +1,75 @@
-=begin
-  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+# frozen_string_literal: true
 
-  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#   This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
 
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
+module Viewpoint
+  module EWS
+    module SOAP
+      # Parse the incoming response document via a SAX parser instead of the
+      # traditional DOM parser. In early benchmarks this was performing about
+      # 132% faster than the DOM-based parser for large documents.
+      class EwsSaxDocument < Nokogiri::XML::SAX::Document
+        include Viewpoint::EWS
+        include Viewpoint::StringUtils
 
-    http://www.apache.org/licenses/LICENSE-2.0
+        attr_reader :struct
 
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-=end
+        def initialize
+          super
+          @struct = {}
+          @elems  = []
+        end
 
-module Viewpoint::EWS::SOAP
-  # Parse the incoming response document via a SAX parser instead of the
-  # traditional DOM parser. In early benchmarks this was performing about
-  # 132% faster than the DOM-based parser for large documents.
-  class EwsSaxDocument < Nokogiri::XML::SAX::Document
-    include Viewpoint::EWS
-    include Viewpoint::StringUtils
+        def characters(string)
+          # FIXME: Move white space removal to somewhere else.
+          # This function can be called multiple times. In this case newlines in Text Bodies get stripped.
+          # See: https://github.com/zenchild/Viewpoint/issues/90
+          # string.strip!
+          return if string.empty?
 
-    attr_reader :struct
+          if @elems.last[:text]
+            @elems.last[:text] += string
+          else
+            @elems.last[:text] = string
+          end
+        end
 
-    def initialize
-      @struct = {}
-      @elems  = []
-    end
-
-    def characters(string)
-      # FIXME: Move white space removal to somewhere else.
-      # This function can be called multiple times. In this case newlines in Text Bodies get stripped.
-      # See: https://github.com/zenchild/Viewpoint/issues/90
-      #string.strip!
-      return if string.empty?
-      if @elems.last[:text]
-        @elems.last[:text] += string
-      else
-        @elems.last[:text] = string
-      end
-    end
+        def start_element_namespace(name, attributes = [], _prefix = nil, _uri = nil, _namespaces = [])
+          ruby_case(name).to_sym
+          elem = {}
+          unless attributes.empty?
+            elem[:attribs] = attributes.collect { |a|
+              { ruby_case(a.localname).to_sym => a.value }
+            }.inject(&:merge)
+          end
+          @elems << elem
+        end
 
-    def start_element_namespace(name, attributes = [], prefix = nil, uri = nil, ns = [])
-      name = ruby_case(name).to_sym
-      elem = {}
-      unless attributes.empty?
-        elem[:attribs] = attributes.collect{|a|
-          { ruby_case(a.localname).to_sym => a.value}
-        }.inject(&:merge)
+        def end_element_namespace(name, _prefix = nil, _uri = nil)
+          name = ruby_case(name).to_sym
+          elem = @elems.pop
+          if @elems.empty?
+            @struct[name] = elem
+          else
+            @elems.last[:elems] = [] unless @elems.last[:elems].is_a?(Array)
+            @elems.last[:elems] << { name => elem }
+          end
+        end
       end
-      @elems << elem
     end
-
-    def end_element_namespace name, prefix=nil, uri=nil
-      name = ruby_case(name).to_sym
-      elem = @elems.pop
-      if @elems.empty?
-        @struct[name] = elem
-      else
-        @elems.last[:elems] = [] unless @elems.last[:elems].is_a?(Array)
-        @elems.last[:elems] << {name => elem}
-      end
-    end
-
   end
 end

data/lib/ews/soap/response_message.rb

@@ -1,74 +1,75 @@
-=begin
-  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-=end
-
-module Viewpoint::EWS::SOAP
-  class ResponseMessage
-
-    attr_reader :message, :type
-
-    def initialize(message)
-      @type    = message.keys.first
-      @message = message[@type]
-    end
-
-    def response_class
-      message[:attribs][:response_class]
-    end
-    alias :status :response_class
-
-    def success?
-      response_class == 'Success'
-    end
-
-    def message_text
-      safe_hash_access message, [:elems, :message_text, :text]
-    end
-
-    def response_code
-      safe_hash_access message, [:elems, :response_code, :text]
-    end
-    alias :code :response_code
-
-    def message_xml
-      safe_hash_access message, [:elems, :message_xml, :text]
-    end
-
-    def items
-      safe_hash_access(message, [:elems, :items, :elems]) || []
-    end
-
-
-    private
-
-
-    def safe_hash_access(hsh, keys)
-      key = keys.shift
-      return nil unless hsh.is_a?(Hash) && hsh.has_key?(key)
-
-      if keys.empty?
-        hsh[key]
-      else
-        safe_hash_access hsh[key], keys
+# frozen_string_literal: true
+
+#   This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+module Viewpoint
+  module EWS
+    module SOAP
+      # Base class for parsed SOAP response messages.
+      class ResponseMessage
+        attr_reader :message, :type
+
+        def initialize(message)
+          @type    = message.keys.first
+          @message = message[@type]
+        end
+
+        def response_class
+          message[:attribs][:response_class]
+        end
+        alias status response_class
+
+        def success?
+          response_class == 'Success'
+        end
+
+        def message_text
+          safe_hash_access message, %i[elems message_text text]
+        end
+
+        def response_code
+          safe_hash_access message, %i[elems response_code text]
+        end
+        alias code response_code
+
+        def message_xml
+          safe_hash_access message, %i[elems message_xml text]
+        end
+
+        def items
+          safe_hash_access(message, %i[elems items elems]) || []
+        end
+
+        private
+
+        def safe_hash_access(hsh, keys)
+          key = keys.shift
+          return nil unless hsh.is_a?(Hash) && hsh.key?(key)
+
+          if keys.empty?
+            hsh[key]
+          else
+            safe_hash_access hsh[key], keys
+          end
+        end
       end
     end
-
   end
-end # Viewpoint::EWS::SOAP
+end
 
 require_relative './responses/create_item_response_message'
 require_relative './responses/create_attachment_response_message'

data/lib/ews/soap/responses/create_attachment_response_message.rb

@@ -1,47 +1,47 @@
-=begin
-  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-=end
-
-module Viewpoint::EWS::SOAP
-
-  class CreateAttachmentResponseMessage < ResponseMessage
-    include Viewpoint::StringUtils
-
-    def attachments
-      return @attachments if @attachments
-
-      a = safe_hash_access message, [:elems, :attachments, :elems]
-      @attachments = a.nil? ? nil : parse_attachments(a)
-    end
-
-
-    private
-
-
-    def parse_attachments(att)
-      att.collect do |a|
-        type = a.keys.first
-        klass = Viewpoint::EWS::Types.const_get(camel_case(type))
-        item = OpenStruct.new
-        item.ews = nil
-        klass.new(item, a[type])
+# frozen_string_literal: true
+
+#   This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+module Viewpoint
+  module EWS
+    module SOAP
+      # Parses the Create Attachment operation SOAP response.
+      class CreateAttachmentResponseMessage < ResponseMessage
+        include Viewpoint::StringUtils
+
+        def attachments
+          return @attachments if @attachments
+
+          a = safe_hash_access message, %i[elems attachments elems]
+          @attachments = a.nil? ? nil : parse_attachments(a)
+        end
+
+        private
+
+        def parse_attachments(att)
+          att.collect do |a|
+            type = a.keys.first
+            klass = Viewpoint::EWS::Types.const_get(camel_case(type))
+            item = OpenStruct.new
+            item.ews = nil
+            klass.new(item, a[type])
+          end
+        end
       end
     end
-
-  end # CreateAttachmentResponseMessage
-
-end # Viewpoint::EWS::SOAP
+  end
+end

data/lib/ews/soap/responses/create_item_response_message.rb

@@ -1,25 +1,26 @@
-=begin
-  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-=end
-
-module Viewpoint::EWS::SOAP
-
-  class CreateItemResponseMessage < ResponseMessage
-
-  end # CreateItemResponseMessage
-
-end # Viewpoint::EWS::SOAP
+# frozen_string_literal: true
+
+#   This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+module Viewpoint
+  module EWS
+    module SOAP
+      class CreateItemResponseMessage < ResponseMessage
+      end
+    end
+  end
+end

data/lib/ews/soap/responses/find_item_response_message.rb

@@ -1,80 +1,78 @@
-=begin
-  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
-
-  Licensed under the Apache License, Version 2.0 (the "License");
-  you may not use this file except in compliance with the License.
-  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
-=end
-
-module Viewpoint::EWS::SOAP
-
-  class RootFolder
-
-    attr_reader :root
-
-    def initialize(root)
-      @root = root
-    end
-
-    def indexed_paging_offset
-      attrib :index_paging_offset
-    end
-
-    def numerator_offset
-      attrib :numerator_offset
-    end
-
-    def absolute_denominator
-      attrib :absolute_denominator
-    end
-
-    def includes_last_item_in_range
-      attrib :includes_last_item_in_range
-    end
-
-    def total_items_in_view
-      attrib :total_items_in_view
-    end
-
-    def items
-      root[:elems][0][:items][:elems] || []
-    end
-
-    def groups
-      root[:elems][0][:groups][:elems]
-    end
-
-
-    private
-    
-
-    def attrib(key)
-      return nil unless root.has_key?(:attribs)
-      root[:attribs][key]
+# frozen_string_literal: true
+
+#   This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+module Viewpoint
+  module EWS
+    module SOAP
+      # Root folder reference in FindItem responses.
+      class RootFolder
+        attr_reader :root
+
+        def initialize(root)
+          @root = root
+        end
+
+        def indexed_paging_offset
+          attrib :index_paging_offset
+        end
+
+        def numerator_offset
+          attrib :numerator_offset
+        end
+
+        def absolute_denominator
+          attrib :absolute_denominator
+        end
+
+        def includes_last_item_in_range
+          attrib :includes_last_item_in_range
+        end
+
+        def total_items_in_view
+          attrib :total_items_in_view
+        end
+
+        def items
+          root[:elems][0][:items][:elems] || []
+        end
+
+        def groups
+          root[:elems][0][:groups][:elems]
+        end
+
+        private
+
+        def attrib(key)
+          return nil unless root.key?(:attribs)
+
+          root[:attribs][key]
+        end
+      end
+
+      # Parses the Find Item operation SOAP response.
+      class FindItemResponseMessage < ResponseMessage
+        def root_folder
+          return @root_folder if @root_folder
+
+          rf = safe_hash_access message, %i[elems root_folder]
+          @root_folder = rf.nil? ? nil : RootFolder.new(rf)
+        end
+      end
     end
-
   end
-
-
-  class FindItemResponseMessage < ResponseMessage
-
-    def root_folder
-      return @root_folder if @root_folder
-
-      rf = safe_hash_access message, [:elems, :root_folder]
-      @root_folder = rf.nil? ? nil : RootFolder.new(rf)
-    end
-
-  end # FindItemResponseMessage
-
-end # Viewpoint::EWS::SOAP
+end