Merge pull request #4 from ekohe/feature/office356_add_contact_api

FEATURE - Add contact API and add params to message API

Author: encoreshao

.rubocop.yml

@@ -17,3 +17,6 @@ Metrics/AbcSize:
 
 Style/Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Max: 150

Gemfile.lock

@@ -90,6 +90,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-21
   x86_64-linux
 

README.md

@@ -49,13 +49,21 @@ client.calendars
 
 ```ruby
 client.messages
+client.messages({ filter: "createdDateTime lt 2022-01-01" })
+client.messages_with_nextlink
+client.messages_with_nextlink(next_link: true, params: { filter: "createdDateTime lt 2022-01-01" })
+```
+
+**Get all contact**
+
+```ruby
+client.contacts
 ```
 
 ## Copyright
 
 Copyright (c) 2022 Encore Shao. See LICENSE for details.
 
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ekohe/ruby-office365.

lib/office365/rest/api.rb

@@ -3,6 +3,7 @@
 require_relative "./user"
 require_relative "./mailbox"
 require_relative "./calendar"
+require_relative "./contact"
 require_relative "./token"
 
 module Office365
@@ -11,6 +12,7 @@ module API
       include Office365::REST::User
       include Office365::REST::Mailbox
       include Office365::REST::Calendar
+      include Office365::REST::Contact
       include Office365::REST::Token
     end
   end

lib/office365/rest/contact.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Office365
+  module REST
+    module Contact
+      def contacts
+        contacts_uri = ["/", Office365::API_VERSION, "/me/contacts"].join
+        response = Request.new(access_token, debug: debug).get(contacts_uri)
+
+        response["value"].map { |v| Models::User.new(v) }
+      end
+    end
+  end
+end

lib/office365/rest/mailbox.rb

@@ -3,15 +3,15 @@
 module Office365
   module REST
     module Mailbox
-      def messages
-        message_response["value"].map { |v| Models::Mailbox.new(v) }
+      def messages(params = {})
+        message_response(params: params)["value"].map { |v| Models::Mailbox.new(v) }
       end
 
       # response = client.messages_with_nextlink
       # response[:results].each -> data save
       # if response[:next_link].present? client.messages_with_nextlink(response[:next_link])
-      def messages_with_nextlink(next_link = nil)
-        response = message_response(next_link)
+      def messages_with_nextlink(next_link: nil, params: {})
+        response = message_response(next_link: next_link, params: params)
 
         {
           results: response["value"].map { |v| Models::Mailbox.new(v) },
@@ -21,8 +21,14 @@ def messages_with_nextlink(next_link = nil)
 
       private
 
-      def message_response(next_link = nil)
-        messages_uri = next_link || ["/", Office365::API_VERSION, "/me/messages"].join
+      def message_response(params: {}, next_link: nil)
+        messages_uri = ["/", Office365::API_VERSION, "/me/messages"].join
+        if params.any?
+          messages_uri = [messages_uri, "?", params.to_query].join
+        elsif next_link
+          messages_uri = next_link
+        end
+
         Request.new(access_token, debug: debug).get(messages_uri)
       end
     end

lib/office365/utils.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require "office365/utils/string"
+require "office365/utils/to_query"

lib/office365/utils/to_query.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+class Object
+  # Alias of <tt>to_s</tt>.
+  def to_param
+    to_s
+  end
+
+  # Converts an object into a string suitable for use as a URL query string,
+  # using the given <tt>key</tt> as the param name.
+  def to_query(key)
+    "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+  end
+end
+
+class NilClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class TrueClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class FalseClass
+  # Returns +self+.
+  def to_param
+    self
+  end
+end
+
+class Array
+  # Calls <tt>to_param</tt> on all its elements and joins the result with
+  # slashes. This is used by <tt>url_for</tt> in Action Pack.
+  def to_param
+    collect(&:to_param).join "/"
+  end
+
+  # Converts an array into a string suitable for use as a URL query string,
+  # using the given +key+ as the param name.
+  #
+  #   ['Rails', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
+  def to_query(key)
+    prefix = "#{key}[]"
+
+    if empty?
+      nil.to_query(prefix)
+    else
+      collect { |value| value.to_query(prefix) }.join "&"
+    end
+  end
+end
+
+class Hash
+  # Returns a string representation of the receiver suitable for use as a URL
+  # query string:
+  #
+  #   {name: 'David', nationality: 'Danish'}.to_query
+  #   # => "name=David&nationality=Danish"
+  #
+  # An optional namespace can be passed to enclose key names:
+  #
+  #   {name: 'David', nationality: 'Danish'}.to_query('user')
+  #   # => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"
+  #
+  # The string pairs "key=value" that conform the query string
+  # are sorted lexicographically in ascending order.
+  #
+  # This method is also aliased as +to_param+.
+  def to_query(namespace = nil)
+    query = collect do |key, value|
+      unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
+        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+      end
+    end.compact
+
+    query.sort! unless namespace.to_s.include?("[]")
+    query.join("&")
+  end
+
+  alias to_param to_query
+end