Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PlaceOS/office365
Crystal Lang MS Graph API integration
https://github.com/PlaceOS/office365
Last synced: 25 days ago
JSON representation
Crystal Lang MS Graph API integration
- Host: GitHub
- URL: https://github.com/PlaceOS/office365
- Owner: PlaceOS
- License: mit
- Created: 2020-04-02T23:53:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-28T23:48:48.000Z (7 months ago)
- Last Synced: 2024-08-04T01:08:54.869Z (4 months ago)
- Language: Crystal
- Homepage:
- Size: 188 KB
- Stars: 8
- Watchers: 9
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - office365 - Microsoft Graph API wrapper (Third-party APIs)
README
[](https://github.com/PlaceOS/office365/actions/workflows/crystal.yml)
# office365
Implements the Microsoft Office365 Graph API for the follow
* OAuth Token Generation
- By providing credentials via argument
* User
- list Users
- get User
* Groups
- get a group
- list group members
- list a members groups
* Calendar
- list Calendars
- list Calendar Groups
- create Calendar
- create Calendar Group
- delete Calendar
- delete Calendar Group
- availability
* Events
- list Events
- create Event
- get Event
- update Event
- delete Event
* Attachments
- list Attachments
- create Attachment
- get Attachment
- delete Attachment
* Mail
- send mail
* Place
- List Places
- Get Place
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
office365:
github: PlaceOS/office365
```
2. Run `shards install`
## Usage
```crystal
require "office365"
```
### Authentication
#### Office365::Client
```crystal
client = Office365::Client.new(
tenant: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
client_id: "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
client_secret: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
)
```
### Users
```crystal
# id can be either user id, or email
user = client.get_user(id: "[email protected])
# get all users
users = client.list_users
# get top 25 users
users = client.list_users(limit: 25)
# get top 100 users whose email or display name starts with "foo"
users = client.list_users(q: "foo", limit: 100)
```
### Calendars
```crystal
# fetch all [email protected]'s calendars
calendars = client.list_calendars(mailbox: "[email protected]")
# fetch all [email protected]'s calendar from default calendar group
calendars = client.list_calendars(mailbox: "[email protected]", calendar_group_id: "default")
# fetch all [email protected]'s calendars from a specific calendar group id
calendars = client.list_calendars(mailbox: "[email protected]", calendar_group_id: "xxxx-xxxx...")
# fetch [email protected]'s calendars whose name exactly matches "garys calendar"
calendars = client.list_calendars(mailbox: "[email protected]", match: "garys calendar")
# fetch [email protected]'s calendars whose name starts with "gary"
calendars = client.list_calendars(mailbox: "[email protected]", search: "gary")
# fetch all foo@bars calendar groups, limit is optional
groups = client.list_calendar_groups(mailbox: "[email protected]", limit: 25)
# create a new calendar, returns an Office365::Calendar objectj
calendar = client.create(
mailbox: "[email protected]", # required
name: "My New Calendar", # required
calendar_group_id: "..." # optional
)
# create a calendar group
group = client.create_calendar_group(mailbox: "[email protected]", name: "A Whole New Calendar Group!")
# deleting a calendar
client.delete_calendar(
mailbox: "[email protected]", # required
id: "...", # required
calendar_group_id: "..." # optional
)
# deleting a calendar group
client.delete_calendar_group(
mailbox: "[email protected]", # required
id: "...", # required
)
# fetching availability for a list of calendars
client.get_availability(
mailbox: "[email protected]", # required
mailboxes: ["[email protected]", "[email protected]"], # required
starts_at: Time.local(location: Time::Location.build("Australia/Sydney")), # required query time starting from
ends_at: Time.local(location: Time::Location.build("Australia/Sydney")) + 30.minutes, # required query time ending at
)
```
### Events
```crystal
# list events, returns Office365::EventQuery
list = client.list_events(
mailbox: "[email protected]", # required
calendar_id: "...", # optional
calendar_group_id: "..." # optional
)
# create an event
event = client.create_event(
mailbox: "[email protected]",
starts_at: Time.local(location: Time::Location.build("Australia/Sydney")),
ends_at: Time.local(location: Time::Location.build("Australia/Sydney")) + 30.minutes,
calendar_id: "...",
calendar_group_id: "...",
subject: "My Meeting",
description: "A description of my meeting",
# attendee's can be either a string, EmailAddress, or Attendee
attendees[
"[email protected]",
EmailAddress.new("David Bowie", "[email protected]"),
Attendee.new(
email: "[email protected]",
type: Office365::AttendeeType::Optional
)
],
# adds an attendee of type AttendeeType::Resource
location: "The Red Room",
# adds recurrence
recurrence: RecurrenceParam.new(pattern: "daily", range_end: Time.local(location: Time::Location.build("Australia/Sydney")).at_beginning_of_day + 5.days),
# specify sensitivity
sensitivity: Office365::Sensitivity::Normal,
# adds attendees of type AttendeeType::Resource, string or email address will work
rooms:[
"[email protected]",
EmailAddress.new("David Bowie", "[email protected]"),
]
)
# get an event
event = client.get_event(mailbox: "[email protected]", id: "...")
# update an event
event.description = "Updated: Something new" # update description
event.set_recurrence(RecurrenceParam.new(pattern: "daily", range_end: Time.local(location: Time::Location.build("Australia/Sydney")).at_beginning_of_day + 7.days)) # update recurrence
updated_event = client.update_event(event: event, mailbox: "[email protected]")
# delete event
client.delete_event(mailbox: "[email protected]", id: "...")
```
### Attachments
```crystal
# list attachments, returns Office365::AttachmentQuery
list = client.list_attachments(
mailbox: "[email protected]", # required
event_id: "1234", # required
calendar_id: "...", # optional
calendar_group_id: "..." # optional
)
# create an attachment for an event
attachment = client.create_attachment(
mailbox: "[email protected]",
event_id: "1234",
name: "test.txt",
content_bytes: "hello worlds" # file contents as string
)
# get an attachment
attachment = client.get_attachment(mailbox: "[email protected]", event_id: "1234", id: "...")
# delete attachment
client.delete_attachment(mailbox: "[email protected]", event_id: "1234", id: "...")
```
## Development
To run specs `crystal spec`
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request