Merge pull request #7 from ekohe/feature/single_event_request_and_sub…

…scription_support

FEATURE #3335 single event request and subscription support

.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.idea/
 /.yardoc
 /_yardoc/
 /coverage/

README.md

@@ -100,6 +100,15 @@ 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 +180,37 @@ 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.

lib/office365/models.rb

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

lib/office365/models/subscription.rb

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

lib/office365/rest/api.rb

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

lib/office365/rest/concerns/base.rb

@@ -7,8 +7,13 @@ module Base
         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) },

lib/office365/rest/event.rb

@@ -6,11 +6,18 @@ module Office365
   module REST
     module Event
       include Concerns::Base
+      BASE_URI = "/me/events"
 
       # params: args => { next_link: (nil / next_page_url) }
       # response { results: [], next_link: '...' }
       def events(args = {})
-        wrap_results(args.merge(kclass: Models::Event, base_uri: "/me/events"))
+        wrap_results(args.merge(kclass: Models::Event, base_uri: BASE_URI))
+      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

lib/office365/rest/request.rb

@@ -28,23 +28,35 @@ def get(uri, args: {})
       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

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