ruby-office365 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25c6ebfd49566d52252acf88d545334c3836df70727334f6fe7dc420b3ec2d2
-  data.tar.gz: f7513d00478b3db8206dade494d02d401ebf998b9e22b2707c19a0ee8d017b12
+  metadata.gz: d51b843c237dae5d0af62db257a4ae5889d03e00b62fdce26f679717139a9fe6
+  data.tar.gz: 1cdb8e3c0229f929acd5354fcea731253c7535e57fbe355cc2ee816ef54597a6
 SHA512:
-  metadata.gz: 84ebf0fc3fb83ea4a529a38880ea4dc10c932dbb7c0b6a57804d0e53b337dba1ff7669981af84c5b04cfff519a1e9062199c5d9f70cdd506906460b3b1cd7ca0
-  data.tar.gz: 7af1f230a6ba4e5f76a23f1cd28ad0399efd64ff1c91a1da9c05c2c903806b070dbc860a82945c527b8c5efd581e0c611a6db530424c3a9e5fb6b0ceffd05cf0
+  metadata.gz: b970531fc4df3e763a6b15a997e3bf0557e3e0b08772eb1d5fe4b37d17bdde9c78d95f8bd3729b2764f0a8378aa4ccd9baa56ce7abae5f35d5e21a4259fcf1c5
+  data.tar.gz: 9ad0c123acddf7965596ccd0be7ff1a0ffb710f1f665cbda60c52a6f6d4ef94641818d0404e9bd6a9b33bb1d5d15a0e43d7c36f5c7418b2a074db01d93d43fab

data/.rubocop.yml

@@ -22,4 +22,7 @@ Metrics/BlockLength:
   Max: 150
 
 Metrics/MethodLength:
-  Max: 50
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 20

data/CHANGELOG.md

@@ -34,4 +34,10 @@
 
 - Integrate REST API to get events
   - get events `client.events`
-  - get events data with next link `client.events({next_link: 'xxx'})`
+  - get events data with next link `client.events({next_link: 'xxx'})`
+
+## [0.1.7] - (2022-11-11)
+
+- 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' })`

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,5 @@
-# Office 365 (2022)
-
-A simple ruby library to interact with Microsoft Graph and Office 365 API.
-
-- https://developer.microsoft.com/en-us/graph/graph-explorer
+# Office 365 (2022) <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
 
@@ -14,6 +11,11 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install ruby-office365
 
+## Features
+
+- Supports user's mailboxes, calendars, contacts, events
+- Supports refresh token
+
 ## Configuration
 
 You can pass configuration options as a block to `Office365::REST::Client.new`.

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

@@ -6,7 +6,7 @@ module Office365
   module Models
     class Base < OpenStruct
       def initialize(response = {})
-        super(response.transform_keys(&:o_underscore))
+        super(response.transform_keys(&:rails_underscore))
       end
 
       def as_json

data/lib/office365/models/event.rb

@@ -3,6 +3,7 @@
 module Office365
   module Models
     class Event < Base
+      # attr_accessor :id, :subject, :body, :start, :end, :location, :attendees, :organizer
     end
   end
 end

data/lib/office365/rest/api.rb

@@ -4,8 +4,8 @@ require_relative "./user"
 require_relative "./mailbox"
 require_relative "./calendar"
 require_relative "./contact"
-require_relative "./token"
 require_relative "./event"
+require_relative "./token"
 
 module Office365
   module REST
@@ -13,9 +13,9 @@ module Office365
       include Office365::REST::User
       include Office365::REST::Mailbox
       include Office365::REST::Calendar
+      include Office365::REST::Event
       include Office365::REST::Contact
       include Office365::REST::Token
-      include Office365::REST::Event
     end
   end
 end

data/lib/office365/rest/calendar.rb

@@ -10,12 +10,7 @@ module Office365
       # 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"))
-
-        {
-          results: response["value"].map { |v| Models::Calendar.new(v) },
-          next_link: response["@odata.nextLink"]
-        }
+        wrap_results(args.merge(kclass: Models::Calendar, base_uri: "/me/calendars"))
       end
     end
   end

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

@@ -6,21 +6,51 @@ module Office365
       module Base
         private
 
-        def message_response(args: {})
-          next_link = args.delete(:next_link)
+        def wrap_results(args)
+          kclass    = args.delete(:kclass)
+          response  = get_request(args: args)
 
-          request_uri = if next_link
-                          next_link
-                        else
-                          base_uri = args.delete(:base_uri)
+          {
+            results: response["value"].map { |v| kclass.new(v) },
+            next_link: response["@odata.nextLink"]
+          }
+        end
 
-                          req_uri = ["/", Office365::API_VERSION, base_uri].join
-                          req_uri += ["?", args.to_query].join if args.any?
-                          req_uri
-                        end
+        def get_request(args: {})
+          request_uri = parse_and_build_request_url(args)
 
           Request.new(access_token, debug: debug).get(request_uri)
         end
+
+        # https://learn.microsoft.com/en-us/graph/query-parameters?view=graph-rest-1.0
+        # OData system query options
+        # Click the examples to try them in [Graph Explorer](https://developer.microsoft.com/zh-cn/graph/graph-explorer)
+
+        # $count  Retrieves the total count of matching resources.  /me/messages?$top=2&$count=true
+        # $expand Retrieves related resources.  /groups?$expand=members
+        # $filter Filters results (rows). /users?$filter=startswith(givenName,'J')
+        # $format Returns the results in the specified media format.  /users?$format=json
+        # $orderby  Orders results. /users?$orderby=displayName desc
+        # $search Returns results based on search criteria. /me/messages?$search=pizza
+        # $select Filters properties (columns). /users?$select=givenName,surname
+        # $skip Indexes into a result set.
+        #   Also used by some APIs to implement paging and can be used together with $top to manually page results.  /me/messages?$skip=11
+        # $top  Sets the page size of results.  /users?$top=2
+        def parse_and_build_request_url(args)
+          next_link = args.delete(:next_link)
+          return next_link unless next_link.nil?
+
+          # organize params
+          base_uri        = args.delete(:base_uri)
+          select_fields   = args.delete(:select)
+          order_by        = args.delete(:order)
+          args[:select]   = select_fields.map(&:rails_camelize).join(",") if select_fields.is_a?(Array)
+          args[:orderby]  = order_by if order_by
+
+          request_uri = ["/", Office365::API_VERSION, base_uri].join
+          request_uri += ["?", args.ms_hash_to_query].join if args.any?
+          request_uri
+        end
       end
     end
   end

data/lib/office365/rest/contact.rb

@@ -10,12 +10,7 @@ module Office365
       # 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"))
-
-        {
-          results: response["value"].map { |v| Models::Contact.new(v) },
-          next_link: response["@odata.nextLink"]
-        }
+        wrap_results(args.merge(kclass: Models::Contact, base_uri: "/me/contacts"))
       end
     end
   end

data/lib/office365/rest/event.rb

@@ -10,12 +10,7 @@ module Office365
       # params: args => { next_link: (nil / next_page_url) }
       # response { results: [], next_link: '...' }
       def events(args = {})
-        response = message_response(args: args.merge(base_uri: "/me/events"))
-
-        {
-          results: response["value"].map { |v| Models::Event.new(v) },
-          next_link: response["@odata.nextLink"]
-        }
+        wrap_results(args.merge(kclass: Models::Event, base_uri: "/me/events"))
       end
     end
   end

data/lib/office365/rest/mailbox.rb

@@ -10,12 +10,7 @@ module Office365
       # 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"]
-        }
+        wrap_results(args.merge(kclass: Models::Mailbox, base_uri: "/me/messages"))
       end
     end
   end

data/lib/office365/rest/request.rb

@@ -34,7 +34,7 @@ module Office365
           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)
+        end.post(req_url.request_uri, args.ms_hash_to_query)
 
         parse_respond(response)
       end
@@ -45,8 +45,14 @@ module Office365
         resp_body = response.body
 
         return resp_body if response.status == 200
-        raise InvalidAuthenticationTokenError, resp_body.dig("error", "message") if response.status == 401
+
         raise InvaliRequestError, resp_body["error_description"] if response.status == 400
+        raise InvalidAuthenticationTokenError, resp_body.dig("error", "message") if response.status == 401
+        raise AccessDeniedError, resp_body.dig("error", "message") if response.status == 403
+        raise NotFoundError, resp_body.dig("error", "message") if response.status == 404
+        raise ThrottlingError, resp_body.dig("error", "message") if response.status == 429
+
+        raise ServiceUnavailableError, resp_body.dig("error", "message") if response.status == 503
 
         raise Error, resp_body["error"]
       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/string.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class String
-  def o_underscore
+  def rails_underscore
     gsub(/::/, "/")
       .gsub(/@/, "")
       .gsub(/\./, "_")
@@ -10,4 +10,18 @@ class String
       .tr("-", "_")
       .downcase
   end
+
+  # rubocop:disable Style/SymbolProc
+  def rails_camelize(uppercase_first_letter: false)
+    string = self
+    return string if string !~ /_/ && string =~ /[A-Z]+.*/
+
+    string = if uppercase_first_letter
+               string.sub(/^[a-z\d]*/) { |match| match.capitalize }
+             else
+               string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+             end
+    string.gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{::Regexp.last_match(1)}#{::Regexp.last_match(2).capitalize}" }.gsub("/", "::")
+  end
+  # rubocop:enable Style/SymbolProc
 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.6"
+  VERSION = "0.1.8"
 end

data/lib/office365.rb

@@ -12,6 +12,12 @@ module Office365
   class InvalidAuthenticationTokenError < StandardError; end
   class InvaliRequestError < StandardError; end
 
+  # Handling expected errors -> https://learn.microsoft.com/en-us/graph/best-practices-concept#handling-expected-errors
+  class AccessDeniedError < StandardError; end
+  class NotFoundError < StandardError; end
+  class ThrottlingError < StandardError; end
+  class ServiceUnavailableError < StandardError; end
+
   API_HOST      = "https://graph.microsoft.com"
   API_VERSION   = "v1.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-office365
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-01 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -135,8 +135,8 @@ files:
 - 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

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