fact: combine requests to get data with pagination

Author: Encore Shao

CHANGELOG.md

@@ -11,7 +11,14 @@
   - get mailbox `client.messages`
   - get calenders `client.calenders`
 
-## [0.1.1] - (2022-10-21)
+## [0.1.2] - (2022-10-21)
 
 - Integrate REST API to get mailbox with pagination
-  - get mailbox data with next link `client.messages_with_nextlink`
+  - get mailbox data with next link `client.messages({next_link: 'xxx'})`
+  - get mailbox data with next link `client.calenders({next_link: 'xxx'})`
+
+## [0.1.3] - (2022-10-26)
+
+- Integrate REST API to get contacts
+  - get profile `client.contacts`
+  - get contacts data with next link `client.contacts({next_link: 'xxx'})`

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-office365 (0.1.2)
+    ruby-office365 (0.1.3)
       faraday
       faraday_middleware
 

README.md

@@ -33,31 +33,103 @@ end
 
 After configuring a `client`, you can do the following things.
 
+**response**
+
+    - `results`: wrap all data into results
+    - `next_link`: get the new link for the next page of data
+
+**to JSON**
+
+    - `as_json`: convert office365 object to JSON format
+
 **Get Profile (as the authenticated user)**
 
 ```ruby
-client.me
+irb(main):004:0> response = client.me
+irb(main):010:0> response.display_name
+=> "Hello World"
+irb(main):004:0> response.as_json
+=> {
+    :odata_context=>"https://graph.microsoft.com/v1.0/$metadata#users/$entity",
+    :display_name=>"Hello World",
+    :surname=>"Hello",
+    :given_name=>"World",
+    :id=>"d7e954e0b50095ad",
+    :user_principal_name=>"hello.world@mail.com",
+    :business_phones=>[],
+    :job_title=>nil,
+    :mail=>nil,
+    :mobile_phone=>nil,
+    :office_location=>nil,
+    :preferred_language=>nil
+}
 ```
 
-**Get all calendars**
+**Get my calendars**
 
 ```ruby
-client.calendars
+irb(main):005:0> client.calendars
+irb(main):005:0> client.calendars[:results]
+irb(main):005:0> client.calendars[:next_link]
 ```
 
-**Get all mailbox**
+**Get my mails**
 
 ```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" })
+irb(main):005:0> client.messages
+irb(main):005:0> client.messages[:results]
+irb(main):005:0> client.messages({ filter: "createdDateTime lt 2022-01-01" })
+irb(main):005:0> client.messages({ filter: "createdDateTime lt 2022-01-01", next_link: 'https://....' })
 ```
 
-**Get all contact**
+**Get my contacts**
 
 ```ruby
-client.contacts
+irb(main):018:0> response = client.contacts
+irb(main):020:0> client.contacts[:results][0].display_name
+=> "Encore S."
+irb(main):018:0> response[:results][0].as_json
+=> {
+    :odata_etag=>"W/\"EQAAABYAAACbUc86NQthQ7+Mvj19ecwVAABjabQj\"",
+    :id=>"AQMkADAwATM3ZmYAZS00ZTU5LWY3NwBjLTAwAi0wMAoARgAAA4QFHqPHk4JJj7ZVaRPCKk4HAJtRzzo1C2FDv4y_PX15zBUAAAIBDgAAAJtRzzo1C2FDv4y_PX15zBUAAABja1I_AAAA",
+    :created_date_time=>"2022-10-24T02:48:56Z",
+    :last_modified_date_time=>"2022-10-24T02:48:57Z",
+    :change_key=>"EQAAABYAAACbUc86NQthQ7+Mvj19ecwVAABjabQj",
+    :categories=>[],
+    :parent_folder_id=>"AQMkADAwATM3ZmYAZS00ZTU5LWY3NwBjLTAwAi0wMAoALgAAA4QFHqPHk4JJj7ZVaRPCKk4BAJtRzzo1C2FDv4y_PX15zBUAAAIBDgAAAA==",
+    :birthday=>nil,
+    :file_as=>"",
+    :display_name=>"Name S.",
+    :given_name=>"Name",
+    :initials=>nil,
+    :middle_name=>nil,
+    :nick_name=>nil,
+    :surname=>"S.",
+    :title=>nil,
+    :yomi_given_name=>nil,
+    :yomi_surname=>nil,
+    :yomi_company_name=>"",
+    :generation=>nil,
+    :im_addresses=>[],
+    :job_title=>"",
+    :company_name=>nil,
+    :department=>"",
+    :office_location=>"",
+    :profession=>nil,
+    :business_home_page=>"",
+    :assistant_name=>"",
+    :manager=>"",
+    :home_phones=>[],
+    :mobile_phone=>"",
+    :business_phones=>[],
+    :spouse_name=>"",
+    :personal_notes=>"",
+    :children=>[],
+    :email_addresses=>[{"name"=>"name@google.com", "address"=>"name@google.com"}],
+    :home_address=>{},
+    :business_address=>{},
+    :other_address=>{}
+}
 ```
 
 ## Copyright

lib/office365/models.rb

@@ -9,5 +9,6 @@ module Models
     autoload :User,               "office365/models/user"
     autoload :Owner,              "office365/models/owner"
     autoload :EmailAddress,       "office365/models/email_address"
+    autoload :Contact,            "office365/models/contact"
   end
 end

lib/office365/models/contact.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Office365
+  module Models
+    class Contact < Base
+    end
+  end
+end

lib/office365/rest/calendar.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
+require_relative "./concerns/base"
+
 module Office365
   module REST
     module Calendar
-      def calendars
-        calendars_uri = ["/", Office365::API_VERSION, "/me/calendars"].join
-        response = Request.new(access_token, debug: debug).get(calendars_uri)
+      include Concerns::Base
+
+      # params: args => { next_link: (nil / next_page_url) }
+      # response { results: [], next_link: '...' }
+      def calendars(args = {})
+        response = message_response(args: args.merge(base_uri: "/me/calendars"))
 
-        response["value"].map { |v| Models::Calendar.new(v) }
+        {
+          results: response["value"].map { |v| Models::Calendar.new(v) },
+          next_link: response["@odata.nextLink"]
+        }
       end
     end
   end

lib/office365/rest/concerns/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Office365
+  module REST
+    module Concerns
+      module Base
+        private
+
+        def message_response(args: {})
+          next_link = args.delete(:next_link)
+
+          request_uri = if next_link
+                          next_link
+                        else
+                          base_uri = args.delete(:base_uri)
+
+                          req_uri = ["/", Office365::API_VERSION, base_uri].join
+                          req_uri += ["?", args.to_query].join if args.any?
+                          req_uri
+                        end
+
+          Request.new(access_token, debug: debug).get(request_uri)
+        end
+      end
+    end
+  end
+end

lib/office365/rest/contact.rb

@@ -1,13 +1,21 @@
 # frozen_string_literal: true
 
+require_relative "./concerns/base"
+
 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)
+      include Concerns::Base
+
+      # params: args => { next_link: (nil / next_page_url) }
+      # response { results: [], next_link: '...' }
+      def contacts(args = {})
+        response = message_response(args: args.merge(base_uri: "/me/contacts"))
 
-        response["value"].map { |v| Models::User.new(v) }
+        {
+          results: response["value"].map { |v| Models::Contact.new(v) },
+          next_link: response["@odata.nextLink"]
+        }
       end
     end
   end

lib/office365/rest/mailbox.rb

@@ -1,36 +1,22 @@
 # frozen_string_literal: true
 
+require_relative "./concerns/base"
+
 module Office365
   module REST
     module Mailbox
-      def messages(params = {})
-        message_response(params: params)["value"].map { |v| Models::Mailbox.new(v) }
-      end
+      include Concerns::Base
 
-      # 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, params: {})
-        response = message_response(next_link: next_link, params: params)
+      # params: args => { next_link: (nil / next_page_url) }
+      # response { results: [], next_link: '...' }
+      def messages(args = {})
+        response = message_response(args: args.merge(base_uri: "/me/messages"))
 
         {
           results: response["value"].map { |v| Models::Mailbox.new(v) },
           next_link: response["@odata.nextLink"]
         }
       end
-
-      private
-
-      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
   end
 end

lib/office365/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Office365
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end