ruby-office365 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0490fef4bbf78efa42231c69e2b12fdb9f12ec37805c5e846225568e85cb03ba'
-  data.tar.gz: a40082526d63f968875194b969146f787de82090207132c69b7d62c344719c6f
+  metadata.gz: 5ae4eff73f21d319447f7b789178a0befbc9f480631c72b9556e091f395c2905
+  data.tar.gz: b2eeb9e486a6cace523a577c1c08453f6a0061b05d7212302b4fc7cc918f6d7a
 SHA512:
-  metadata.gz: 1a5220233fdf3095a0423a0433b54007ad251cc1bd3dfea051a6c2b2ef3e83586d3142198deda976ffa3425e9c6b97723e0e78af9a564872d2c42e1a9bba7a68
-  data.tar.gz: 445c96c052a74d5ca866769182c98a3da62de4308f83d52db760b5d2bac1fbce3c7be02cdecdfde933ea0d0c3e1c98c264f3175bba68dfbd933c8e29b55f8d15
+  metadata.gz: f4f935c0fb140ef8e7758f6d2f481a9f38ca5acc256a58b1f9679c0efd1d37a60ec1bf06b22be7fd9812c909cde5162e0c4bcc9bd10b3cd1d3badc90e885132a
+  data.tar.gz: a19af99ccc99cacf0beaddca0fa5288d8d0e3020dc01dd6c4eef183a38f1dee0b9144011471d966b16f72a72a400dc6b8e9afc80aced0f9eea1ae08d289cad15

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-office365 (0.1.7)
+    ruby-office365 (0.1.9)
       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

@@ -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.

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) },
@@ -48,7 +53,7 @@ module Office365
           args[:orderby]  = order_by if order_by
 
           request_uri = ["/", Office365::API_VERSION, base_uri].join
-          request_uri += ["?", args.to_query].join if args.any?
+          request_uri += ["?", args.ms_hash_to_query].join if args.any?
           request_uri
         end
       end

data/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

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.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/rest/token.rb

@@ -13,7 +13,7 @@ module Office365
           response_mode: "query",
           redirect_uri: redirect_uri,
           state: SecureRandom.hex
-        }.to_query
+        }.ms_hash_to_query
 
         [base_uri, "?", azure_params].join
       end

data/lib/office365/utils/hash.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+class Hash
+  def ms_hash_to_query
+    query_str = []
+
+    each_pair do |key, value|
+      query_str << "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+    end
+    query_str.join("&")
+  end
+end

data/lib/office365/utils.rb

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

data/lib/office365/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-office365
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2024-08-08 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,11 +133,12 @@ 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
+- lib/office365/utils/hash.rb
 - lib/office365/utils/string.rb
-- lib/office365/utils/to_query.rb
 - lib/office365/version.rb
 - ruby-office365.gemspec
 - sig/office365.rbs
@@ -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.

data/lib/office365/utils/to_query.rb

@@ -1,89 +0,0 @@
-# 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