nm
node-mashov
npm i node-mashov
nm

node-mashov

🏫 A node.js wrapper for Mashov API.

by Yarden Sod-Moriah

1.1.1 (see all)License:MITTypeScript:Built-In
npm i node-mashov
Readme

node-mashov

Build Status npm

A node.js wrapper for Mashov API.

Note that:

  • This wrapper focuses on student accounts, so don't expect for parental/teacher accounts support.
  • I was too scared to test messages sending, so there isn't such feature here.
  • I am not affiliated with Mashov in any way.

For a full list of features, consult the API section.

Install

Install it from npm:

npm install --save node-mashov

Or import it in the browser (from unpkg, for example):

<script src="https://unpkg.com/node-mashov/dist/node-mashov.min.js"></script>

<script>
  const { fetchSchools, Client} = window.nodeMashov;

  // ...
</script>

Usage

Example usage

import { fetchSchools, Client } from 'node-mashov';

(async () => {
  const schools = await fetchSchools();
  const school = schools.find(s => s.name.includes('myschool'));

  const client = new Client();

  client.login({
    username: 'username',
    password: 'supersecret',
    year: school.years[school.years.length - 1],
    school
  }).then(client.getGrades)
    .then((grades) => {
      console.log(grades);
    });
})();

API

Sample reponses from the API can be found here.

fetchSchools()

Returns a Promise for an Array of schools.

new Client()

Create a new client instance.

Client#getAuthDetails()

Client#setAuthDetails(authDetails)

After a successful login, an authDetails object is created, containing the required information for the client to authenticate with the API. You should store those details for future use.

authDetails

Type: Object

Client#setStartDate(startDate)

Client#setEndDate(endDate)

The API lets you specify time range for records. Those methods allows you to utilize this feture.

startDate, endDate

Type: string, null
Format: YYYY-MM-DD

All of the following methods return a Promise

Client#login(userDetails)

Authenticate using the details provided in the constructor.

userDetails

Type: Object

username
password
year
school

Client#logout()

Deauthenticate and destroy authentication details.

Client#getConversations([query], [limit], [skip])

Getting the user's conversations.

query

Type: Object, string
Default: 'inbox'

Mashov's API lets you query conversations. This wrapper does include support for that.

If query is a string, it'll fetch all of the messages matched the type. It could be one of the following:

  • 'inbox' - Inbox
  • 'archive' - Archived messages
  • 'unread' - Unread messages
  • 'deleted' - Deleted messages
  • 'sent' - Messages sent
  • 'draft' - Drafts

Otherwise, you can use a more complex query by making query into an object, with the following properties:

in

Type: string
Default: 'all'

  • 'all' - All conversations
  • 'inbox' - Inbox
  • 'unread' - Unread messages
sender
receiver
subject
body

Type: string

attachment

Type: boolean
Default: false

If true, will query all the conversations that has an attachment. If false, it'll query conversations with or without attachments.

fromDate
toDate

Type: string
Format: YYYY-MM-DD

An example for a valid query:

{
  in: 'unread',
  sender: 'teacher',
  receiver: 'student',
  subject: 'Bring your books tomorrow',
  attachment: true,
  dromDate: '2017-05-01'
}
limit

Type: number
Default: 20

Number of messages to fetch (from start).

skip

Type: number
Default: 0

Number of messages to skip. Can be useful for pagination.

Client#getConversation(conversationId)

Fetch a single conversation.

Example usage:

client.getAllConversations()
  .then(convs => convs[0].id)
  .then(client.getConversation)
  .then((conv) => {
    console.log(conv);
  });

Client#getGrades()

Client#getBagrutGrades()

Client#getBehaveEvents()

Client#getLessonsCount()

Client#getOnlineLessons()

Client#getBells()

Will fetch the user's school's bell schedule.

Client#getTimetable()

Client#getFiles()

Will fetch the user's files (aka study materials)

Client#getGroups()

Client#getContacts()

Client#getGroupContacts()

Example usage:

client.getGroups()
  .then(groups => groups[0].id)
  .then(client.getGroupContacts)
  .then((contacts) => {
    console.log(contacts);
  });

See also

License

MIT © Yarden Sod-Moriah

Downloads/wk

33

GitHub Stars

11

LAST COMMIT

1yr ago

MAINTAINERS

1

CONTRIBUTORS

3

OPEN ISSUES

0

OPEN PRs

13
VersionTagPublished
1.1.1
latest
1yr ago
No alternatives found
No tutorials found
Add a tutorial