ruby-office365 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86ee47df4ac96c36024adb5c0595afa78889dc9659aebcdbdf01a59e407a0db9
-  data.tar.gz: 42ab9271c0d32b6035ad9caecc837137774bde57d0894fd49f34782d8c0f1f1b
+  metadata.gz: b25c6ebfd49566d52252acf88d545334c3836df70727334f6fe7dc420b3ec2d2
+  data.tar.gz: f7513d00478b3db8206dade494d02d401ebf998b9e22b2707c19a0ee8d017b12
 SHA512:
-  metadata.gz: 8dd5a3b6d974b91bf6c2846b1b9b3f433fcc1abe11d6dfc85f3fe3a7b023313db0079b6056a1e27d3d8a36506a434a4ef0e45f327f4d2dd25b0416f681ff5906
-  data.tar.gz: fc2997832814ec584184584546ca7443841914191056f5fd3c080017cf21b273a05f9dd5612b928ad7570fb3cbc202ff0cbaba01e86a62b250c409f1e87776b9
+  metadata.gz: 84ebf0fc3fb83ea4a529a38880ea4dc10c932dbb7c0b6a57804d0e53b337dba1ff7669981af84c5b04cfff519a1e9062199c5d9f70cdd506906460b3b1cd7ca0
+  data.tar.gz: 7af1f230a6ba4e5f76a23f1cd28ad0399efd64ff1c91a1da9c05c2c903806b070dbc860a82945c527b8c5efd581e0c611a6db530424c3a9e5fb6b0ceffd05cf0

data/CHANGELOG.md

@@ -15,12 +15,12 @@
 
 - Integrate REST API to get mailbox with pagination
   - get mailbox data with next link `client.messages({next_link: 'xxx'})`
-  - get mailbox data with next link `client.calenders({next_link: 'xxx'})`
+  - get calenders 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 `client.contacts`
   - get contacts data with next link `client.contacts({next_link: 'xxx'})`
 
 ## [0.1.5] - (2022-10-27)
@@ -28,4 +28,10 @@
 - Generate URLs for token and able to refresh token
   - get authorize URL `client.authorize_url`
   - get token URL `client.token_url`
-  - be able to refresh token `client.refresh_token!`
+  - be able to refresh token `client.refresh_token!`
+
+## [0.1.6] - (2022-11-01)
+
+- Integrate REST API to get events
+  - get events `client.events`
+  - get events data with next link `client.events({next_link: 'xxx'})`

data/Gemfile.lock

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

data/README.md

@@ -1,4 +1,4 @@
-# Office 365
+# Office 365 (2022)
 
 A simple ruby library to interact with Microsoft Graph and Office 365 API.
 
@@ -18,31 +18,48 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 You can pass configuration options as a block to `Office365::REST::Client.new`.
 
+- tenant_id: optional, only required for refresh_token
+- client_id: optional, only required for refresh_token
+- client_secret: optional, only required for refresh_token
+- access_token: required for fetch mailbox, calendars, contacts data
+- refresh_token: optional, only required for refresh_token
+- debug: optional, default false, output the request information
+
+### Used to get data from MS Graph API
+
+```ruby
+client = Office365::REST::Client.new do |config|
+  config.access_token = "YOUR_ACCESS_TOKEN"
+  config.debug = "true/false" # Optional, default to false, output the information in the request
+end
+```
+
+### For refresh token
+
 ```ruby
 client = Office365::REST::Client.new do |config|
-  config.tenant_id          = "YOUR_ORG_TENANT_ID"
-  config.client_id          = "YOUR_APP_CLIENT_ID"
-  config.client_secret      = "YOUR_APP_CLIENT_SECRET"
-  config.redirect_uri       = "YOUR_APP_REDIRECT_URL"
-  config.access_token       = "YOUR_ACCESS_TOKEN"
-  config.refresh_token      = "YOUR_REFRESH_TOKEN"
+  config.tenant_id = "YOUR_ORG_TENANT_ID"
+  config.client_id = "YOUR_APP_CLIENT_ID"
+  config.client_secret = "YOUR_APP_CLIENT_SECRET"
+  config.refresh_token = "YOUR_REFRESH_TOKEN"
+  config.debug = "true/false" # Optional, default to false, output the information in the request
 end
 ```
 
-## Usage Examples
+## Usage
 
 After configuring a `client`, you can do the following things.
 
-**response**
+**Response structure**
 
-    - `results`: wrap all data into results
-    - `next_link`: get the new link for the next page of data
+    - results: wrap all data into results
+    - next_link: get the new link for the next page of data
 
-**to JSON**
+**A simple way to convert an office365 object to JSON**
 
-    - `as_json`: convert office365 object to JSON format
+    - as_json: convert office365 object to JSON format
 
-**Get Profile (as the authenticated user)**
+**Get my profile by access token**
 
 ```ruby
 irb(main):004:0> response = client.me
@@ -65,7 +82,7 @@ irb(main):004:0> response.as_json
 }
 ```
 
-**Get my calendars**
+**Get my calendars by access token**
 
 ```ruby
 irb(main):005:0> client.calendars
@@ -73,7 +90,15 @@ irb(main):005:0> client.calendars[:results]
 irb(main):005:0> client.calendars[:next_link]
 ```
 
-**Get my mails**
+**Get my events by access token**
+
+```ruby
+irb(main):005:0> client.events
+irb(main):005:0> client.events[:results]
+irb(main):005:0> client.events[:next_link]
+```
+
+**Get my mails by access token**
 
 ```ruby
 irb(main):005:0> client.messages
@@ -82,7 +107,7 @@ 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 my contacts**
+**Get my contacts by access token**
 
 ```ruby
 irb(main):018:0> response = client.contacts
@@ -132,7 +157,7 @@ irb(main):018:0> response[:results][0].as_json
 }
 ```
 
-**Refresh User Token**
+**Refresh access token by refresh token**
 
 ```ruby
 irb(main):005:0> response = client.refresh_token!
@@ -144,6 +169,12 @@ irb(main):005:0> response.refresh_token
 => "0.ARgA7EiQdLv1qECnFqPfrznKsT9ERYaGfG9Ki5WzQtEllj8YAJk.AgABAAEAAAD--DLA3VO7QrddgJg7WevrAgDs_wQA9P-Q1ODlBsrdZi-5s2mfLtEsavBgiEhGcz1KEf26fMrGFU3LM_og5l6wjSAtQ83XHLuje0_KYGol26_LGV_uH0F1MwCFR1N3ctwg4_...."
 ```
 
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## Copyright
 
 Copyright (c) 2022 Encore Shao. See LICENSE for details.

data/lib/office365/models/event.rb

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

data/lib/office365/models.rb

@@ -11,5 +11,6 @@ module Office365
     autoload :EmailAddress,       "office365/models/email_address"
     autoload :Contact,            "office365/models/contact"
     autoload :AccessToken,        "office365/models/access_token"
+    autoload :Event,              "office365/models/event"
   end
 end

data/lib/office365/rest/api.rb

@@ -5,6 +5,7 @@ require_relative "./mailbox"
 require_relative "./calendar"
 require_relative "./contact"
 require_relative "./token"
+require_relative "./event"
 
 module Office365
   module REST
@@ -14,6 +15,7 @@ module Office365
       include Office365::REST::Calendar
       include Office365::REST::Contact
       include Office365::REST::Token
+      include Office365::REST::Event
     end
   end
 end

data/lib/office365/rest/event.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "./concerns/base"
+
+module Office365
+  module REST
+    module Event
+      include Concerns::Base
+
+      # 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"]
+        }
+      end
+    end
+  end
+end

data/lib/office365/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-office365
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-27 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,6 +119,7 @@ files:
 - lib/office365/models/contact.rb
 - lib/office365/models/directory.rb
 - lib/office365/models/email_address.rb
+- lib/office365/models/event.rb
 - lib/office365/models/mailbox.rb
 - lib/office365/models/owner.rb
 - lib/office365/models/user.rb
@@ -128,6 +129,7 @@ files:
 - lib/office365/rest/client.rb
 - lib/office365/rest/concerns/base.rb
 - lib/office365/rest/contact.rb
+- lib/office365/rest/event.rb
 - lib/office365/rest/mailbox.rb
 - lib/office365/rest/request.rb
 - lib/office365/rest/token.rb
@@ -161,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: A simple ruby library to interact with Microsoft Graph and Office 365 API.