ruby-office365 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d51b843c237dae5d0af62db257a4ae5889d03e00b62fdce26f679717139a9fe6
-  data.tar.gz: 1cdb8e3c0229f929acd5354fcea731253c7535e57fbe355cc2ee816ef54597a6
+  metadata.gz: 3513de92b0360a54e0d374123fcf895427f951c47bb69b2f3e467898656ab943
+  data.tar.gz: '0600429d86539062c53f5507c02b9b711475ed40ddf2b69bdbad5aabe4f77042'
 SHA512:
-  metadata.gz: b970531fc4df3e763a6b15a997e3bf0557e3e0b08772eb1d5fe4b37d17bdde9c78d95f8bd3729b2764f0a8378aa4ccd9baa56ce7abae5f35d5e21a4259fcf1c5
-  data.tar.gz: 9ad0c123acddf7965596ccd0be7ff1a0ffb710f1f665cbda60c52a6f6d4ef94641818d0404e9bd6a9b33bb1d5d15a0e43d7c36f5c7418b2a074db01d93d43fab
+  metadata.gz: f2a8a7ab82422310f3a2abcc14efe98cc009b137e543f3c3001846a5649f933730baddcf98c9341eda9992042b6d3fe85959d8c650dac94965ca549ee1389e90
+  data.tar.gz: c7fcbf2ad9effed4e531c805de17a023c77a3b067e18ea467057956209aeb9109dc06c9542c401b4e28c73fc5e0aada76f71e52dbe3ae4dd28f72fa67188b60d

data/CHANGELOG.md

@@ -1,27 +1,25 @@
 # Office365 Library Changelog
 
-## [0.1.0] - (2022-10-19)
+## [0.2.0] - (2024-11-14)
 
-- Project setup and push to rubugems
+- New feature on events: Allows users to get events by expected dates
+  - get events for the next week `client.events({ startdatetime: "2024-11-14T00:00:00.000Z", enddatetime: "2024-11-21T00:00:00.000Z" })`
 
-## [0.1.1] - (2022-10-21)
+## [0.1.9] - (2024-08-08)
 
-- Integrate REST API to get data from Graph API
-  - get profile `client.me`
-  - get mailbox `client.messages`
-  - get calenders `client.calenders`
+- able to get event by identifier `client.event('xxxxxxxx')`
 
-## [0.1.2] - (2022-10-21)
+## [0.1.7] - (2022-11-11)
 
-- Integrate REST API to get mailbox with pagination
-  - get mailbox data with next link `client.messages({next_link: 'xxx'})`
-  - get calenders data with next link `client.calenders({next_link: 'xxx'})`
+- Improve performance: supports select and sort in REST APIs
+  - get messages by select fields `client.messages({ select: %[id] })`
+  - get messages by custom order `client.messages({ order: 'id asc' })`
 
-## [0.1.3] - (2022-10-26)
+## [0.1.6] - (2022-11-01)
 
-- Integrate REST API to get contacts
-  - get contacts `client.contacts`
-  - get contacts data with next link `client.contacts({next_link: 'xxx'})`
+- Integrate REST API to get events
+  - get events `client.events`
+  - get events data with next link `client.events({next_link: 'xxx'})`
 
 ## [0.1.5] - (2022-10-27)
 
@@ -30,14 +28,25 @@
   - get token URL `client.token_url`
   - be able to refresh token `client.refresh_token!`
 
-## [0.1.6] - (2022-11-01)
+## [0.1.3] - (2022-10-26)
 
-- Integrate REST API to get events
-  - get events `client.events`
-  - get events data with next link `client.events({next_link: 'xxx'})`
+- Integrate REST API to get contacts
+  - get contacts `client.contacts`
+  - get contacts data with next link `client.contacts({next_link: 'xxx'})`
 
-## [0.1.7] - (2022-11-11)
+## [0.1.2] - (2022-10-21)
 
-- Improve performance: supports select and sort in REST APIs
-  - get messages by select fields `client.messages({ select: %[id] })`
-  - get messages by custom order `client.messages({ order: 'id asc' })`
+- Integrate REST API to get mailbox with pagination
+  - get mailbox data with next link `client.messages({next_link: 'xxx'})`
+  - get calenders data with next link `client.calenders({next_link: 'xxx'})`
+
+## [0.1.1] - (2022-10-21)
+
+- Integrate REST API to get data from Graph API
+  - get profile `client.me`
+  - get mailbox `client.messages`
+  - get calenders `client.calenders`
+
+## [0.1.0] - (2022-10-19)
+
+- Project setup and push to rubugems

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-office365 (0.1.8)
+    ruby-office365 (0.2.0)
       faraday
       faraday_middleware
 
@@ -15,7 +15,7 @@ GEM
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
-    faraday (1.10.2)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -33,7 +33,7 @@ GEM
     faraday-httpclient (1.0.1)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (1.0.1)
+    faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
@@ -43,7 +43,7 @@ GEM
     hashdiff (1.0.1)
     json (2.6.2)
     method_source (1.0.0)
-    multipart-post (2.2.3)
+    multipart-post (2.4.1)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)

data/README.md

@@ -1,4 +1,5 @@
-# Office 365 (2022) <img src="https://i.ibb.co/g3mpswn/microsoft-office-365-logo-2016-100727915-large.webp" align="right" width="250" height="150">
+# Office 365 (2024) <img src="https://i.ibb.co/g3mpswn/microsoft-office-365-logo-2016-100727915-large.webp" align="right" width="250" height="150">
+
 A simple ruby library to interact with Microsoft Graph **[Explorer](https://developer.microsoft.com/en-us/graph/graph-explorer)** and Office 365 API
 
 ## Installation
@@ -100,6 +101,23 @@ irb(main):005:0> client.events[:results]
 irb(main):005:0> client.events[:next_link]
 ```
 
+**Get my events for the next week**
+
+```ruby
+irb(main):005:0> client.events({ startdatetime: "2024-11-14T00:00:00.000Z", enddatetime: "2024-11-21T00:00:00.000Z" })
+irb(main):005:0> client.events[:results]
+irb(main):005:0> client.events[:next_link]
+```
+
+**Get my event by id**
+
+```ruby
+irb(main):005:0> client.event('identifier')
+irb(main):005:0> client.event('identifier')[:results]
+```
+
+Results will return an array even if it is a single result.
+
 **Get my mails by access token**
 
 ```ruby
@@ -171,6 +189,36 @@ irb(main):005:0> response.refresh_token
 => "0.ARgA7EiQdLv1qECnFqPfrznKsT9ERYaGfG9Ki5WzQtEllj8YAJk.AgABAAEAAAD--DLA3VO7QrddgJg7WevrAgDs_wQA9P-Q1ODlBsrdZi-5s2mfLtEsavBgiEhGcz1KEf26fMrGFU3LM_og5l6wjSAtQ83XHLuje0_KYGol26_LGV_uH0F1MwCFR1N3ctwg4_...."
 ```
 
+**Create Subscription: it will create a webhook for Office365**
+
+```ruby
+args = {
+  changeType: "updated,deleted",
+  notificationUrl: "https://hello-world.com/office365/notifications",
+  lifecycleNotificationUrl: "https://hello-world.com/office365/lifecycle_notifications",
+  resource: "/me/{type}",
+  expirationDateTime: "2024-08-07T12:00:00.0000000Z",
+  clientState: "SecretClientState"
+}
+
+irb(main):005:0> subscription = client.create_subscription(args)
+```
+
+will return the subscription object `Office365::Models::Subscription`
+
+**Renew Subscription**
+
+```ruby
+args = {
+  identifier: "subscription-identifier",
+  expirationDateTime: "2024-08-08T12:00:00.0000000Z"
+}
+
+irb(main):005:0> subscription = client.renew_subscription(args)
+```
+
+will return the subscription object `Office365::Models::Subscription`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/office365/models/subscription.rb

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

data/lib/office365/models.rb

@@ -12,5 +12,6 @@ module Office365
     autoload :Contact,            "office365/models/contact"
     autoload :AccessToken,        "office365/models/access_token"
     autoload :Event,              "office365/models/event"
+    autoload :Subscription,       "office365/models/subscription"
   end
 end

data/lib/office365/rest/api.rb

@@ -5,6 +5,7 @@ require_relative "./mailbox"
 require_relative "./calendar"
 require_relative "./contact"
 require_relative "./event"
+require_relative "./subscription"
 require_relative "./token"
 
 module Office365
@@ -16,6 +17,7 @@ module Office365
       include Office365::REST::Event
       include Office365::REST::Contact
       include Office365::REST::Token
+      include Office365::REST::Subscription
     end
   end
 end

data/lib/office365/rest/concerns/base.rb

@@ -7,8 +7,13 @@ module Office365
         private
 
         def wrap_results(args)
-          kclass    = args.delete(:kclass)
-          response  = get_request(args: args)
+          kclass     = args.delete(:kclass)
+          identifier = args.delete(:identifier)
+
+          response = get_request(args: args)
+
+          # If we are getting a single item by id, return the result as an array
+          return { results: [kclass.new(response)].flatten } unless identifier.nil?
 
           {
             results: response["value"].map { |v| kclass.new(v) },

data/lib/office365/rest/event.rb

@@ -6,11 +6,30 @@ module Office365
   module REST
     module Event
       include Concerns::Base
+      BASE_URI = "/me/events"
+      CALENDARVIEW_URL = "/me/calendarview"
 
       # params: args => { next_link: (nil / next_page_url) }
+      #   startdatetime: 2024-11-14T07:59:41.313Z
+      #   enddatetime: 2024-11-21T07:59:41.313Z
       # response { results: [], next_link: '...' }
       def events(args = {})
-        wrap_results(args.merge(kclass: Models::Event, base_uri: "/me/events"))
+        if args[:startdatetime] && args[:enddatetime]
+          wrap_results(
+            kclass: Models::Event,
+            base_uri: CALENDARVIEW_URL,
+            startdatetime: args[:startdatetime],
+            enddatetime: args[:enddatetime]
+          )
+        else
+          wrap_results(args.merge(kclass: Models::Event, base_uri: BASE_URI))
+        end
+      end
+
+      def event(identifier)
+        raise ArgumentError, "Identifier must be provided" if identifier.nil? || identifier.empty?
+
+        wrap_results(kclass: Models::Event, base_uri: [BASE_URI, identifier].join("/"), identifier: identifier)
       end
     end
   end

data/lib/office365/rest/request.rb

@@ -28,23 +28,35 @@ module Office365
       end
 
       def post(uri, args)
-        req_url = URI(uri.start_with?("https") ? uri : (Office365::API_HOST + uri))
+        response = faraday_action(__method__, uri, args)
+        parse_respond(response)
+      end
 
-        response = Faraday.new(url: [req_url.scheme, "://", req_url.hostname].join, headers: post_headers) do |faraday|
-          faraday.adapter Faraday.default_adapter
-          faraday.response :json
-          faraday.response :logger, ::Logger.new($stdout), bodies: true if dev_developement?
-        end.post(req_url.request_uri, args.ms_hash_to_query)
+      def patch(uri, args)
+        response = faraday_action(__method__, uri, args)
 
         parse_respond(response)
       end
 
       private
 
+      def faraday_action(method_name, uri, args)
+        req_url = URI(uri.start_with?("https") ? uri : (Office365::API_HOST + uri))
+        json_header = args.delete(:json_header)
+
+        faraday = Faraday.new(url: [req_url.scheme, "://", req_url.hostname].join, headers: json_header ? headers : post_headers) do |f|
+          f.adapter Faraday.default_adapter
+          f.response :json
+          f.response :logger, ::Logger.new($stdout), bodies: true if dev_developement?
+        end
+
+        faraday.send(method_name, req_url.request_uri, json_header ? args.to_json : args.ms_hash_to_query)
+      end
+
       def parse_respond(response)
         resp_body = response.body
 
-        return resp_body if response.status == 200
+        return resp_body if [200, 201].include?(response.status)
 
         raise InvaliRequestError, resp_body["error_description"] if response.status == 400
         raise InvalidAuthenticationTokenError, resp_body.dig("error", "message") if response.status == 401

data/lib/office365/rest/subscription.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Office365
+  module REST
+    module Subscription
+      def create_subscription(args = {})
+        raise ArgumentError, "Missing changeType" if args[:changeType].nil?
+        raise ArgumentError, "Missing notificationUrl" if args[:notificationUrl].nil?
+        raise ArgumentError, "Missing resource" if args[:resource].nil?
+        raise ArgumentError, "Missing expirationDateTime" if args[:expirationDateTime].nil?
+        raise ArgumentError, "Missing clientState" if args[:clientState].nil?
+
+        Models::Subscription.new(
+          Request.new(access_token, debug: debug).post("/v1.0/subscriptions", { json_header: true }.merge(args))
+        )
+      end
+
+      def renew_subscription(args = {})
+        raise ArgumentError, "Missing subscription identifier" if args[:identifier].nil?
+
+        identifier = args.delete(:identifier)
+
+        Models::Subscription.new(
+          Request.new(access_token, debug: debug).patch("/v1.0/subscriptions/#{identifier}", { json_header: true }.merge(args))
+        )
+      end
+    end
+  end
+end

data/lib/office365/utils/hash.rb

@@ -11,4 +11,4 @@ class Hash
     end
     query_str.join("&")
   end
-end
+end

data/lib/office365/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-office365
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2024-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,7 @@ files:
 - lib/office365/models/event.rb
 - lib/office365/models/mailbox.rb
 - lib/office365/models/owner.rb
+- lib/office365/models/subscription.rb
 - lib/office365/models/user.rb
 - lib/office365/rest.rb
 - lib/office365/rest/api.rb
@@ -132,6 +133,7 @@ files:
 - lib/office365/rest/event.rb
 - lib/office365/rest/mailbox.rb
 - lib/office365/rest/request.rb
+- lib/office365/rest/subscription.rb
 - lib/office365/rest/token.rb
 - lib/office365/rest/user.rb
 - lib/office365/utils.rb
@@ -163,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A simple ruby library to interact with Microsoft Graph and Office 365 API.