BBLearnWrapper 2.0.9

BB Learn Wrapper

Table of Contents:

• About the Project
• Supported Requests
• Examples
  • Hiding pagination
• Contributing
  • Local Development

About the Project

BB Learn Wrapper is a REST api client for Blackboard Learn api. This library is not associated with Blackboard.

With BB Learn Wrapper you will:

• write queries to Learn Api with a Fluent grammar

• have a library continuously tested

Supported Requests

• Get a Course and Courses
• Get a Column Grade and all Column Grades
• Get a Grade Column and all Grade Columns
• Get a User and all Users

Examples

Quick Start

Create a new instance of BB Learn Wrapper api using:

Learn learn = new Learn(
    bb_url,
    bb_secret,
    bb_username
    );

After that, you can call BB Learn api server using:

// Prepare the request.
CourseRequest courseRequest = learn.Course(courseId);
// Execute the request invoking `GetAsync` method.
Course courseResult = await courseRequest.GetAsync();

You can go deep with additional fluent grammar method chain:

// Prepared and executed request.
Response<GradeColumn> gradeColumnsResponse = await learn.Course(courseId).Gradebook().Columns().Get();

Note: you will make any request until you invoke a Get/Post/Put/Delete (deprecated) or GetAsync/PostAsync/PutAsync/DeleteAsync method.

Hiding pagination

If a response has more than 200 results (default for Blackboard, you can set any limit by your own), calling like this:

Response<ColumnGrade> gradesResult = await columnGradeRequest.Get();

it will return paginated:

{
    "results": [...
    ],
    "paging": {
        "nextPage": "/learn/.../users?offset=200"
    }
}

The nextPage value is the url to call to get the next 200 results for the request:

Response<ColumnGrade> gradesResult = await columnGradeRequest.Get(offset: 200);

it will return paginated:

{
    "results": [...
    ],
    "paging": {
        "nextPage": "/learn/.../users?offset=400"
    }
}

and so on until you obtain this result:

{
    "results": [...
    ]
}

so you can stop to query the server.

The library can follow those links automatically using the parameter follow: true in the GET request:

Response<ColumnGrade> gradesResult = await columnGradeRequest.Get(follow: true);

returning:

{
    "results": [...
    ]
}

where "results" containing all results.

Contributing

You can contribute by creating more requests endpoint callers and more unit tests. After that, you can work to make this library more fault tollerant and more generic, to speed up development of new features.

The central development branch is main, which should be clean and ready for release at any time. In general, all changes should be done as feature branches off of main. To make a one-off code change:

1. Choose a descriptive branch name. It should be lowercase, hyphen-separated, and a noun describing the change, (so, fuzzy-rules, but not implement-fuzzy-rules). Also, it shouldn't start with hotfix or release

2. Create a new branch with this name, starting from main. In other words, run:

   git fetch upstream git checkout main git merge upstream/main git checkout -b your-branch-name

3. Make a commit to your feature branch. Each commit should be self-contained and have a descriptive commit message that helps other developers understand why the changes were made.

4. When your feature is ready to merge, create a pull request.

5. Address review comments until all reviewers give LGTM (looks good to me)

6. Wait reviewers merging your pull request and celebrate! You have contributed to bb-learn-wrapper.

Local Development

Fill C:\work\work\BBLearnWrapper\BBLearnWrapper.Tests\Properties\launchSettings.json file with your credentials for a Learn instance to run unit tests in your local environment.

Refer to BB Dev Doc for new api and model documentation.

You can contribute adding more unit tests, adding documentation to implemented api and improving code readability.

You can investigate on the possibility to use Flurl or Restsharp as http library.